@datocms/cma-client 3.1.5 → 3.1.6

package/src/generated/SimpleSchemaTypes.ts

@@ -8787,49 +8787,49 @@ export type BuildTrigger = {
   id: BuildTriggerIdentity;
   type: BuildTriggerType;
   /**
-   * Name of the environment
+   * Name of the build trigger
    */
   name: string;
   /**
-   * The deploy adapter
+   * The type of build trigger
    */
-  adapter: string;
+  adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
   /**
-   * Additional configuration for deploy
+   * Additional settings for the build trigger. The value depends on the `adapter`.
    */
   adapter_settings: {
     [k: string]: unknown;
   };
   /**
-   * Timestamp of the last deploy
+   * Timestamp of the last build
    */
   last_build_completed_at: string | null;
   /**
-   * Status of last deploy
+   * Status of last build
    */
   build_status: string;
   /**
-   * Unique token of the webhook
+   * Unique token for the webhook (it's the same token present in `webhook_url`)
    */
   webhook_token?: string;
   /**
-   * Notification webhook URL
+   * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
    */
   webhook_url: string;
   /**
-   * Status of site scraper
+   * Status of Site Search for the frontend
    */
   indexing_status: string;
   /**
-   * Public url of the site
+   * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
    */
   frontend_url: string | null;
   /**
-   * Deploy on scheduled publication
+   * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
    */
   autotrigger_on_scheduled_publications: boolean;
   /**
-   * Enable scraper on the site
+   * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
    */
   indexing_enabled: boolean;
 };
@@ -8845,49 +8845,49 @@ export type BuildTriggerDestroyTargetSchema = BuildTrigger;
  */
 export type BuildTriggerAttributes = {
   /**
-   * Name of the environment
+   * Name of the build trigger
    */
   name: string;
   /**
-   * The deploy adapter
+   * The type of build trigger
    */
-  adapter: string;
+  adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
   /**
-   * Additional configuration for deploy
+   * Additional settings for the build trigger. The value depends on the `adapter`.
    */
   adapter_settings: {
     [k: string]: unknown;
   };
   /**
-   * Timestamp of the last deploy
+   * Timestamp of the last build
    */
   last_build_completed_at: string | null;
   /**
-   * Status of last deploy
+   * Status of last build
    */
   build_status: string;
   /**
-   * Unique token of the webhook
+   * Unique token for the webhook (it's the same token present in `webhook_url`)
    */
   webhook_token?: string;
   /**
-   * Notification webhook URL
+   * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
    */
   webhook_url: string;
   /**
-   * Status of site scraper
+   * Status of Site Search for the frontend
    */
   indexing_status: string;
   /**
-   * Public url of the site
+   * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
    */
   frontend_url: string | null;
   /**
-   * Deploy on scheduled publication
+   * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
    */
   autotrigger_on_scheduled_publications: boolean;
   /**
-   * Enable scraper on the site
+   * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
    */
   indexing_enabled: boolean;
 };
@@ -8899,31 +8899,31 @@ export type BuildTriggerAttributes = {
 export type BuildTriggerCreateSchema = {
   type?: BuildTriggerType;
   /**
-   * Name of the environment
+   * Name of the build trigger
    */
   name: string;
   /**
-   * Unique token of the webhook
+   * Unique token for the webhook (it's the same token present in `webhook_url`)
    */
   webhook_token?: string;
   /**
-   * The deploy adapter
+   * The type of build trigger
    */
-  adapter: string;
+  adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
   /**
-   * Enable scraper on the site
+   * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
    */
   indexing_enabled: boolean;
   /**
-   * Public url of the site
+   * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
    */
   frontend_url: string | null;
   /**
-   * Deploy on scheduled publication
+   * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
    */
   autotrigger_on_scheduled_publications: boolean;
   /**
-   * Additional configuration for deploy
+   * Additional settings for the build trigger. The value depends on the `adapter`.
    */
   adapter_settings: {
     [k: string]: unknown;
@@ -8938,27 +8938,27 @@ export type BuildTriggerUpdateSchema = {
   id?: BuildTriggerIdentity;
   type?: BuildTriggerType;
   /**
-   * Name of the environment
+   * Name of the build trigger
    */
   name?: string;
   /**
-   * The deploy adapter
+   * The type of build trigger
    */
-  adapter?: string;
+  adapter?: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
   /**
-   * Enable scraper on the site
+   * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
    */
   indexing_enabled?: boolean;
   /**
-   * Public url of the site
+   * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
    */
   frontend_url?: string | null;
   /**
-   * Deploy on scheduled publication
+   * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
    */
   autotrigger_on_scheduled_publications?: boolean;
   /**
-   * Additional configuration for deploy
+   * Additional settings for the build trigger. The value depends on the `adapter`.
    */
   adapter_settings?: {
     [k: string]: unknown;

package/src/idUtils.ts

@@ -0,0 +1,83 @@
+import { v4 } from 'uuid';
+
+const decoder = new TextDecoder('utf8');
+
+function fromUint8ArrayToUrlSafeBase64(bytes: Uint8Array) {
+  const base64 =
+    typeof Buffer === 'undefined'
+      ? btoa(decoder.decode(bytes))
+      : Buffer.from(bytes).toString('base64');
+
+  // Convert to URL-safe format (see RFC 4648, sec. 5)
+  return (
+    base64
+      // Replace + with -
+      .replace(/\+/g, '-')
+      // Replace / with _
+      .replace(/\//g, '_')
+      // Drop '==' padding
+      .substring(0, 22)
+  );
+}
+
+function fromUrlSafeBase64toUint8Array(urlSafeBase64: string): Uint8Array {
+  // Convert from URL-safe format (see RFC 4648, sec. 5)
+  const base64 = urlSafeBase64
+    // Replace - with +
+    .replace(/-/g, '+')
+    // Replace _ with /
+    .replace(/_/g, '/');
+
+  return typeof Buffer === 'undefined'
+    ? Uint8Array.from(atob(base64), (c) => c.charCodeAt(0))
+    : new Uint8Array(Buffer.from(base64, 'base64'));
+}
+
+export function isValidId(id: string) {
+  const bytes = fromUrlSafeBase64toUint8Array(id);
+
+  // UUIDs are 16 bytes
+  if (bytes.length !== 16) {
+    return false;
+  }
+
+  // The variant field determines the layout of the UUID
+  // (see RFC 4122, sec. 4.1.1)
+
+  const variant = bytes.at(8)!;
+
+  // Variant must be the one described in RFC 4122
+  if ((variant & 0b11000000) !== 0b10000000) {
+    return false;
+  }
+
+  // The version number is in the most significant 4 bits
+  // of the time stamp (see RFC 4122, sec. 4.1.3)
+
+  const version = bytes.at(6)! >> 4;
+
+  // Version number must be 4 (randomly generated)
+  if (version !== 0x4) {
+    return false;
+  }
+
+  return true;
+}
+
+export function generateId() {
+  const bytes = v4(null, new Uint8Array(16));
+
+  // Here we unset the first bit to ensure [A-Za-f] as the first char.
+  //
+  // If we didn't do this, we would generate IDs that, once encoded
+  // in base64, could start with a '+' or a '/'. This makes them less
+  // easy to copy/paste, with bad DX.
+
+  // This choice is purely aesthetic: definitely non-mandatory!
+
+  bytes[0] = bytes[0]! & 0x7f;
+
+  const base64 = fromUint8ArrayToUrlSafeBase64(bytes);
+
+  return base64;
+}

package/src/index.ts

@@ -1,9 +1,9 @@
-export { ApiError, TimeoutError, LogLevel } from '@datocms/rest-client-utils';
+export { ApiError, LogLevel, TimeoutError } from '@datocms/rest-client-utils';
+export * from './buildBlockRecord';
+export * from './buildClient';
 export { Client } from './generated/Client';
-export * as Resources from './generated/resources';
 export type { ClientConfigOptions } from './generated/Client';
-export * from './buildClient';
-export * from './buildBlockRecord';
-export * from './generateId';
+export * as Resources from './generated/resources';
 export * as SchemaTypes from './generated/SchemaTypes';
 export * as SimpleSchemaTypes from './generated/SimpleSchemaTypes';
+export * from './idUtils';

package/dist/cjs/generateId.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateId = void 0;
-var uuid_1 = require("uuid");
-var decoder = new TextDecoder('utf8');
-function toBase64(bytes) {
-    if (typeof Buffer !== 'undefined') {
-        return Buffer.from(bytes).toString('base64');
-    }
-    return btoa(decoder.decode(bytes));
-}
-function generateId() {
-    var bytes = (0, uuid_1.v4)(null, new Uint8Array(16));
-    // unset first bit to ensure [A-Za-f] first char
-    bytes[0] = bytes[0] & 0x7f;
-    var base64 = toBase64(bytes);
-    return (base64
-        // Replace + with - (see RFC 4648, sec. 5)
-        .replace(/\+/g, '-')
-        // Replace / with _ (see RFC 4648, sec. 5)
-        .replace(/\//g, '_')
-        // Drop '==' padding
-        .substring(0, 22));
-}
-exports.generateId = generateId;
-//# sourceMappingURL=generateId.js.map

package/dist/cjs/generateId.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generateId.js","sourceRoot":"","sources":["../../src/generateId.ts"],"names":[],"mappings":";;;AAAA,6BAA0B;AAC1B,IAAM,OAAO,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;AAExC,SAAS,QAAQ,CAAC,KAAiB;IACjC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;QACjC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KAC9C;IAED,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACrC,CAAC;AAED,SAAgB,UAAU;IACxB,IAAM,KAAK,GAAG,IAAA,SAAE,EAAC,IAAI,EAAE,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;IAE3C,gDAAgD;IAChD,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC;IAE5B,IAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE/B,OAAO,CACL,MAAM;QACJ,0CAA0C;SACzC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;QACpB,0CAA0C;SACzC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;QACpB,oBAAoB;SACnB,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CACpB,CAAC;AACJ,CAAC;AAjBD,gCAiBC"}

package/dist/esm/generateId.d.ts

@@ -1 +0,0 @@
-export declare function generateId(): string;

package/dist/esm/generateId.js

@@ -1,22 +0,0 @@
-import { v4 } from 'uuid';
-var decoder = new TextDecoder('utf8');
-function toBase64(bytes) {
-    if (typeof Buffer !== 'undefined') {
-        return Buffer.from(bytes).toString('base64');
-    }
-    return btoa(decoder.decode(bytes));
-}
-export function generateId() {
-    var bytes = v4(null, new Uint8Array(16));
-    // unset first bit to ensure [A-Za-f] first char
-    bytes[0] = bytes[0] & 0x7f;
-    var base64 = toBase64(bytes);
-    return (base64
-        // Replace + with - (see RFC 4648, sec. 5)
-        .replace(/\+/g, '-')
-        // Replace / with _ (see RFC 4648, sec. 5)
-        .replace(/\//g, '_')
-        // Drop '==' padding
-        .substring(0, 22));
-}
-//# sourceMappingURL=generateId.js.map

package/dist/esm/generateId.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generateId.js","sourceRoot":"","sources":["../../src/generateId.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAC1B,IAAM,OAAO,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;AAExC,SAAS,QAAQ,CAAC,KAAiB;IACjC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;QACjC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KAC9C;IAED,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,UAAU;IACxB,IAAM,KAAK,GAAG,EAAE,CAAC,IAAI,EAAE,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;IAE3C,gDAAgD;IAChD,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC;IAE5B,IAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE/B,OAAO,CACL,MAAM;QACJ,0CAA0C;SACzC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;QACpB,0CAA0C;SACzC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;QACpB,oBAAoB;SACnB,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CACpB,CAAC;AACJ,CAAC"}

package/dist/types/generateId.d.ts

@@ -1 +0,0 @@
-export declare function generateId(): string;

package/src/generateId.ts

@@ -1,29 +0,0 @@
-import { v4 } from 'uuid';
-const decoder = new TextDecoder('utf8');
-
-function toBase64(bytes: Uint8Array) {
-  if (typeof Buffer !== 'undefined') {
-    return Buffer.from(bytes).toString('base64');
-  }
-
-  return btoa(decoder.decode(bytes));
-}
-
-export function generateId() {
-  const bytes = v4(null, new Uint8Array(16));
-
-  // unset first bit to ensure [A-Za-f] first char
-  bytes[0] = bytes[0]! & 0x7f;
-
-  const base64 = toBase64(bytes);
-
-  return (
-    base64
-      // Replace + with - (see RFC 4648, sec. 5)
-      .replace(/\+/g, '-')
-      // Replace / with _ (see RFC 4648, sec. 5)
-      .replace(/\//g, '_')
-      // Drop '==' padding
-      .substring(0, 22)
-  );
-}