[DOCS-2743] Replace FQLX beta docs links in main branch (#261)

Co-authored-by: Paul Paterson <[email protected]>
fauna · May 8, 2024 · a54f4a9 · a54f4a9
1 parent 36e264f
commit a54f4a9
Show file tree

Hide file tree

Showing 7 changed files with 726 additions and 393 deletions.
diff --git a/package.json b/package.json
@@ -27,12 +27,12 @@
     "eslint": "^8.25.0",
     "eslint-plugin-tsdoc": "^0.2.17",
     "husky": "^8.0.1",
-    "jest": "^29.4.2",
+    "jest": "^29.7.0",
     "jest-fetch-mock": "^3.0.3",
-    "jest-junit": "^12.0.0",
+    "jest-junit": "^16.0.0",
     "prettier": "^2.7.1",
     "pretty-quick": "^3.1.3",
-    "ts-jest": "^29.0.3",
+    "ts-jest": "^29.1.2",
     "ts-node": "^10.9.1",
     "typescript": "^4.8.4"
   },

diff --git a/src/client-configuration.ts b/src/client-configuration.ts
@@ -87,7 +87,7 @@ export interface ClientConfiguration {
   linearized?: boolean;
 
   /**
-   * Controls what Javascript type to deserialize {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/types#long | Fauna longs} to.
+   * Controls what Javascript type to deserialize {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#long | Fauna longs} to.
    * Use 'number' to deserialize longs to number. Use 'bigint' to deserialize to bigint. Defaults to 'number'.
    * Note, for extremely large maginitude numbers Javascript's number will lose precision; as Javascript's
    * 'number' can only support +/- 2^53-1 whereas Fauna's long is 64 bit. If this is detected, a warning will

diff --git a/src/errors.ts b/src/errors.ts
@@ -67,8 +67,6 @@ export class ServiceError extends FaunaError {
  * QueryRuntimeError's occur when a bug in your query causes an invalid execution
  * to be requested.
  * The 'code' field will vary based on the specific error cause.
- *
- * @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/errors#runtime-errors}
  */
 export class QueryRuntimeError extends ServiceError {
   constructor(failure: QueryFailure, httpStatus: 400) {
@@ -85,8 +83,6 @@ export class QueryRuntimeError extends ServiceError {
 /**
  * An error due to a "compile-time" check of the query
  * failing.
- *
- * @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/errors#runtime-errors}
  */
 export class QueryCheckError extends ServiceError {
   constructor(failure: QueryFailure, httpStatus: 400) {
@@ -101,8 +97,6 @@ export class QueryCheckError extends ServiceError {
 /**
  * An error due to an invalid request to Fauna. Either the request body was not
  * valid JSON or did not conform to the API specification
- *
- * @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/errors#runtime-errors}
  */
 export class InvalidRequestError extends ServiceError {
   constructor(failure: QueryFailure, httpStatus: 400) {
@@ -116,8 +110,6 @@ export class InvalidRequestError extends ServiceError {
 
 /**
  * An error due to calling the FQL `abort` function.
- *
- * @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/errors#runtime-errors}
  */
 export class AbortError extends ServiceError {
   /**

diff --git a/src/values/date-time.ts b/src/values/date-time.ts
@@ -17,7 +17,7 @@ import * as PARSE from "../regex";
  * Converting to a Javascript date before sending to Fauna could result in loss
  * of precision.
  *
- * @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/builtin_functions/time/time}
+ * @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#time}
  */
 export class TimeStub {
   readonly isoString: string;
@@ -104,7 +104,7 @@ export class TimeStub {
  * be taken to specify the desired date, since Javascript `Date`s use local
  * timezone info by default.
  *
- * @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/builtin_functions/date/date}
+ * @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#date}
  */
 export class DateStub {
   readonly dateString: string;

diff --git a/src/values/set.ts b/src/values/set.ts
@@ -4,7 +4,7 @@ import { QueryOptions, QueryValue } from "../wire-protocol";
 
 /**
  * A materialized view of a Set.
- * @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/types#set}
+ * @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#set}
  */
 export class Page<T extends QueryValue> {
   /** A materialized page of data */
@@ -26,7 +26,7 @@ export class Page<T extends QueryValue> {
  * A un-materialized Set. Typically received when a materialized Set contains
  * another set, the EmbeddedSet does not contain any data to avoid potential
  * issues such as self-reference and infinite recursion
- * @see {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/types#set}
+ * @see {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#set}
  */
 export class EmbeddedSet {
   /**

diff --git a/src/wire-protocol.ts b/src/wire-protocol.ts
@@ -52,7 +52,7 @@ export interface QueryOptions {
   linearized?: boolean;
 
   /**
-   * Controls what Javascript type to deserialize {@link https://fqlx-beta--fauna-docs.netlify.app/fqlx/beta/reference/language/types#long | Fauna longs} to.
+   * Controls what Javascript type to deserialize {@link https://docs.fauna.com/fauna/current/reference/fql_reference/types#long | Fauna longs} to.
    * Use 'number' to deserialize longs to number. Use 'bigint' to deserialize to bigint. Defaults to 'number'.
    * Note, for extremely large maginitude numbers Javascript's number will lose precision; as Javascript's
    * 'number' can only support +/- 2^53-1 whereas Fauna's long is 64 bit. If this is detected, a warning will