@squiz/dx-json-schema-lib 1.21.1-alpha.3 → 1.21.1-alpha.31

package/src/manifest/v1/v1.ts

@@ -63,8 +63,18 @@ export type CoreSchemaMetaSchema2 =
        */
       enum?: true[];
       type?:
-        | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText')
-        | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText')[];
+        | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText' | 'SquizImage')
+        | (
+            | 'array'
+            | 'boolean'
+            | 'integer'
+            | 'null'
+            | 'number'
+            | 'object'
+            | 'string'
+            | 'FormattedText'
+            | 'SquizImage'
+          )[];
       format?:
         | 'date-time'
         | 'email'
@@ -313,6 +323,28 @@ export interface ComponentManifest {
   previews?: {
     [k: string]: PreviewDefinition;
   };
+  /**
+   * Mocked uri objects used in the preview
+   */
+  mockedUris?: {
+    /**
+     * Property for defining the mock URI object
+     */
+    [k: string]:
+      | {
+          type: 'file';
+          /**
+           * Path to uri object
+           */
+          path: string;
+          [k: string]: unknown;
+        }
+      | {
+          type: 'inline';
+          value: MatrixAssetSchema;
+          [k: string]: unknown;
+        };
+  };
 }
 /**
  * Icon for the component in Matrix and the DXP
@@ -2631,8 +2663,8 @@ export interface CoreSchemaMetaSchema1 {
    */
   enum?: true[];
   type?:
-    | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText')
-    | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText')[];
+    | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText' | 'SquizImage')
+    | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText' | 'SquizImage')[];
   format?:
     | 'date-time'
     | 'email'
@@ -2932,3 +2964,418 @@ export interface FunctionPreviewConfiguration {
 export interface ResponseHeaders2 {
   [k: string]: string;
 }
+/**
+ * Inline URI object
+ */
+export interface MatrixAssetSchema {
+  /**
+   * The asset ID.
+   */
+  id: string;
+  /**
+   * The asset type code.
+   */
+  type: string;
+  /**
+   * The asset type friendly name.
+   */
+  type_name: string;
+  /**
+   * The asset semantic version.
+   */
+  version: string;
+  /**
+   * The asset standard field name.
+   */
+  name: string;
+  /**
+   * The asset standard field short name.
+   */
+  short_name: string;
+  /**
+   * A object representing the asset status of the asset resource.
+   */
+  status: {
+    /**
+     * The bitwise id of the asset status
+     */
+    id: 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256;
+    /**
+     * The type code of the asset status
+     */
+    code:
+      | 'archived'
+      | 'under_construction'
+      | 'pending_approval'
+      | 'approved'
+      | 'live'
+      | 'live_approval'
+      | 'editing'
+      | 'editing_approval'
+      | 'editing_approved';
+    /**
+     * The description of the asset status
+     */
+    name?:
+      | 'Archived'
+      | 'Under Construction'
+      | 'Pending Approval'
+      | 'Approved To Go Live'
+      | 'Live'
+      | 'Up For Review'
+      | 'Safe Editing'
+      | 'Safe Editing Pending Approval'
+      | 'Safe Edit Approved To Go Live';
+  };
+  /**
+   * A object representing when the asset status was created.
+   */
+  created: {
+    /**
+     * The creation date of the asset in ISO 8601 format.
+     */
+    date: string | null;
+    /**
+     * The asset ID of the User that created the asset.
+     */
+    user_id: string | null;
+  };
+  /**
+   * A object representing when the asset status was last updated.
+   */
+  updated: {
+    /**
+     * The last updated date of the asset in ISO 8601 format.
+     */
+    date: string | null;
+    /**
+     * The asset ID of the User that last updated the asset.
+     */
+    user_id: string | null;
+  };
+  /**
+   * A object representing when the asset status was last published.
+   */
+  published: {
+    /**
+     * The last published date of the asset in ISO 8601 format.
+     */
+    date: string | null;
+    /**
+     * The asset ID of the User that last published the asset.
+     */
+    user_id: string | null;
+  };
+  /**
+   * A object representing when the asset status was last changed.
+   */
+  status_changed?: {
+    /**
+     * The last date the state of the asset was changed in ISO 8601 format.
+     */
+    date: string | null;
+    /**
+     * The asset ID of the User that last changed the asset status.
+     */
+    user_id: string | null;
+  };
+  /**
+   * The primary URL for the asset.
+   */
+  url: string;
+  /**
+   * All URLs for the asset including the primary URL.
+   */
+  urls: string[];
+  /**
+   * List of attributes for the asset in key-value form.
+   */
+  attributes: {
+    [k: string]: unknown;
+  };
+  /**
+   * List of metadata values in key-value form.
+   */
+  metadata?: {
+    [k: string]: string[];
+  };
+  /**
+   * The contents for the asset (excluding file assets).
+   */
+  contents?: string;
+  /**
+   * The thumbnail image associated with the asset, shows a subset data of an image or image variety.
+   */
+  thumbnail?: {
+    /**
+     * The asset ID of the Image asset of the file.
+     */
+    asset_id?: string;
+    /**
+     * The accessible URL of the thumbnail image file.
+     */
+    url?: string;
+    /**
+     * The file name of the thumbnail image.
+     */
+    file_name?: string;
+    /**
+     * The image file width in pixels.
+     */
+    width?: number;
+    /**
+     * The image file height in pixels.
+     */
+    height?: number;
+    /**
+     * The file type of the image file, generally its extension.
+     */
+    file_type?: string;
+    /**
+     * The file size in bytes
+     */
+    file_size?: number;
+    /**
+     * The file size in human readable format
+     */
+    file_size_readable?: number;
+    /**
+     * The friendly name of the file asset
+     */
+    title?: string;
+    /**
+     * The alt attribute of the Image asset
+     */
+    alt?: string;
+    [k: string]: unknown;
+  };
+  /**
+   * All direct dependent child assets of the asset in normalized asset format.
+   */
+  include_dependents?: MatrixAssetSchema1[];
+  /**
+   * Additional data of an arbitrary nature related to the requested asset, which may include derived information or special child asset information.
+   */
+  additional: AssetAdditionalInfo | FileAdditionalInfo | ImageAdditionalInfo | CalendarEventAdditionalInfo;
+  [k: string]: unknown;
+}
+export interface MatrixAssetSchema1 {
+  /**
+   * The asset ID.
+   */
+  id: string;
+  /**
+   * The asset type code.
+   */
+  type: string;
+  /**
+   * The asset type friendly name.
+   */
+  type_name: string;
+  /**
+   * The asset semantic version.
+   */
+  version: string;
+  /**
+   * The asset standard field name.
+   */
+  name: string;
+  /**
+   * The asset standard field short name.
+   */
+  short_name: string;
+  /**
+   * A object representing the asset status of the asset resource.
+   */
+  status: {
+    /**
+     * The bitwise id of the asset status
+     */
+    id: 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256;
+    /**
+     * The type code of the asset status
+     */
+    code:
+      | 'archived'
+      | 'under_construction'
+      | 'pending_approval'
+      | 'approved'
+      | 'live'
+      | 'live_approval'
+      | 'editing'
+      | 'editing_approval'
+      | 'editing_approved';
+    /**
+     * The description of the asset status
+     */
+    name?:
+      | 'Archived'
+      | 'Under Construction'
+      | 'Pending Approval'
+      | 'Approved To Go Live'
+      | 'Live'
+      | 'Up For Review'
+      | 'Safe Editing'
+      | 'Safe Editing Pending Approval'
+      | 'Safe Edit Approved To Go Live';
+  };
+  /**
+   * A object representing when the asset status was created.
+   */
+  created: {
+    /**
+     * The creation date of the asset in ISO 8601 format.
+     */
+    date: string | null;
+    /**
+     * The asset ID of the User that created the asset.
+     */
+    user_id: string | null;
+  };
+  /**
+   * A object representing when the asset status was last updated.
+   */
+  updated: {
+    /**
+     * The last updated date of the asset in ISO 8601 format.
+     */
+    date: string | null;
+    /**
+     * The asset ID of the User that last updated the asset.
+     */
+    user_id: string | null;
+  };
+  /**
+   * A object representing when the asset status was last published.
+   */
+  published: {
+    /**
+     * The last published date of the asset in ISO 8601 format.
+     */
+    date: string | null;
+    /**
+     * The asset ID of the User that last published the asset.
+     */
+    user_id: string | null;
+  };
+  /**
+   * A object representing when the asset status was last changed.
+   */
+  status_changed?: {
+    /**
+     * The last date the state of the asset was changed in ISO 8601 format.
+     */
+    date: string | null;
+    /**
+     * The asset ID of the User that last changed the asset status.
+     */
+    user_id: string | null;
+  };
+  /**
+   * The primary URL for the asset.
+   */
+  url: string;
+  /**
+   * All URLs for the asset including the primary URL.
+   */
+  urls: string[];
+  /**
+   * List of attributes for the asset in key-value form.
+   */
+  attributes: {
+    [k: string]: unknown;
+  };
+  /**
+   * List of metadata values in key-value form.
+   */
+  metadata?: {
+    [k: string]: string[];
+  };
+  /**
+   * The contents for the asset (excluding file assets).
+   */
+  contents?: string;
+  /**
+   * The thumbnail image associated with the asset, shows a subset data of an image or image variety.
+   */
+  thumbnail?: {
+    /**
+     * The asset ID of the Image asset of the file.
+     */
+    asset_id?: string;
+    /**
+     * The accessible URL of the thumbnail image file.
+     */
+    url?: string;
+    /**
+     * The file name of the thumbnail image.
+     */
+    file_name?: string;
+    /**
+     * The image file width in pixels.
+     */
+    width?: number;
+    /**
+     * The image file height in pixels.
+     */
+    height?: number;
+    /**
+     * The file type of the image file, generally its extension.
+     */
+    file_type?: string;
+    /**
+     * The file size in bytes
+     */
+    file_size?: number;
+    /**
+     * The file size in human readable format
+     */
+    file_size_readable?: number;
+    /**
+     * The friendly name of the file asset
+     */
+    title?: string;
+    /**
+     * The alt attribute of the Image asset
+     */
+    alt?: string;
+    [k: string]: unknown;
+  };
+  /**
+   * All direct dependent child assets of the asset in normalized asset format.
+   */
+  include_dependents?: MatrixAssetSchema1[];
+  /**
+   * Additional data of an arbitrary nature related to the requested asset, which may include derived information or special child asset information.
+   */
+  additional: AssetAdditionalInfo | FileAdditionalInfo | ImageAdditionalInfo | CalendarEventAdditionalInfo;
+  [k: string]: unknown;
+}
+export interface AssetAdditionalInfo {
+  [k: string]: unknown;
+}
+export interface FileAdditionalInfo {
+  file_info: {
+    file_name?: string;
+    size_readable?: string;
+    size_bytes?: number;
+    width?: number;
+    height?: number;
+    modified_readable?: string;
+    modified_unix?: number;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+}
+export interface ImageAdditionalInfo {
+  varieties: MatrixAssetSchema1[];
+  [k: string]: unknown;
+}
+export interface CalendarEventAdditionalInfo {
+  event_info: {
+    duration?: number;
+    frequency?: string;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+}

package/src/primitiveTypes/FormattedText.ts

@@ -0,0 +1,24 @@
+import { FORMATTED_TEXT_SCHEMAS } from '..';
+import { BaseFormattedNodes, FormattedText } from '../formatted-text/v1/formattedText';
+import { PrimitiveType } from '../jsonTypeResolution/TypeResolver';
+
+export const FormattedTextType = PrimitiveType<FormattedText, 'FormattedText'>({
+  ...FORMATTED_TEXT_SCHEMAS.v1,
+  title: 'FormattedText',
+});
+export type FormattedTextType = typeof FormattedTextType;
+
+export const BaseFormattedTextType = PrimitiveType<BaseFormattedNodes[], 'FormattedText'>({
+  ...FORMATTED_TEXT_SCHEMAS.v1,
+  items: {
+    $ref: '#/definitions/BaseFormattedNodes',
+  },
+  title: 'FormattedText',
+});
+export type BaseFormattedTextType = typeof BaseFormattedTextType;
+
+export const ComponentInputFormattedTextType = PrimitiveType<string, 'FormattedText'>({
+  type: 'string',
+  title: 'FormattedText',
+});
+export type ComponentInputFormattedTextType = typeof ComponentInputFormattedTextType;

package/src/primitiveTypes/SquizImage.ts

@@ -0,0 +1,128 @@
+import { PrimitiveType } from '../jsonTypeResolution/TypeResolver';
+
+interface SquizImageData {
+  width: number;
+  height: number;
+  url: string;
+  mimeType: string;
+  byteSize: number;
+  sha1Hash: string;
+  aspectRatio: string; // Enforced validation of something like /\d+:\d+/
+}
+
+interface SquizImageShape {
+  name: string;
+  alt?: string;
+  caption?: string;
+
+  exif?: import('exif').ExifData;
+
+  imageVariations: {
+    original: SquizImageData;
+    small?: SquizImageData[];
+    medium?: SquizImageData[];
+    large?: SquizImageData[];
+    aspectRatios?: SquizImageData[];
+  };
+}
+export const SquizImageType = PrimitiveType<SquizImageShape, 'SquizImage'>({
+  title: 'SquizImage',
+  type: 'object',
+  properties: {
+    name: {
+      type: 'string',
+    },
+    alt: {
+      type: 'string',
+    },
+    caption: {
+      type: 'string',
+    },
+    exif: {
+      type: 'object',
+      properties: {
+        image: {
+          type: 'object',
+        },
+        thumbnail: {
+          type: 'object',
+        },
+        exif: {
+          type: 'object',
+        },
+        gps: {
+          type: 'object',
+        },
+        interoperability: {
+          type: 'object',
+        },
+        makernote: {
+          type: 'object',
+        },
+      },
+      required: ['image', 'thumbnail', 'exif', 'gps', 'interoperability', 'makernote'],
+    },
+    imageVariations: {
+      type: 'object',
+      properties: {
+        original: { $ref: '#/definitions/SquizImageData' },
+        small: {
+          type: 'array',
+          items: {
+            $ref: '#/definitions/SquizImageData',
+          },
+        },
+        medium: {
+          type: 'array',
+          items: {
+            $ref: '#/definitions/SquizImageData',
+          },
+        },
+        large: {
+          type: 'array',
+          items: {
+            $ref: '#/definitions/SquizImageData',
+          },
+        },
+        aspectRatios: {
+          type: 'array',
+          items: {
+            $ref: '#/definitions/SquizImageData',
+          },
+        },
+      },
+      required: ['original'],
+    },
+  },
+  required: ['name', 'imageVariations'],
+  definitions: {
+    SquizImageData: {
+      type: 'object',
+      properties: {
+        width: {
+          type: 'number',
+        },
+        height: {
+          type: 'number',
+        },
+        url: {
+          type: 'string',
+        },
+        mimeType: {
+          type: 'string',
+        },
+        byteSize: {
+          type: 'number',
+        },
+        sha1Hash: {
+          type: 'string',
+        },
+        aspectRatio: {
+          type: 'string',
+        },
+      },
+      required: ['width', 'height', 'url', 'mimeType', 'byteSize', 'sha1Hash', 'aspectRatio'],
+    },
+  },
+});
+export type SquizImageType = typeof SquizImageType;

package/src/primitiveTypes/index.ts

@@ -0,0 +1,2 @@
+export * from './SquizImage';
+export * from './FormattedText';

package/src/resolvableTypes/MatrixAsset.ts

@@ -0,0 +1,24 @@
+import { ResolvableType } from '../jsonTypeResolution/TypeResolver';
+
+interface MatrixAssetShape {
+  matrixAssetId: string;
+  matrixIdentifier: string;
+  matrixDomain?: string;
+}
+export const MatrixAssetType = ResolvableType<MatrixAssetShape, 'MatrixAsset'>({
+  title: 'MatrixAsset',
+  type: 'object',
+  properties: {
+    matrixAssetId: {
+      type: 'string',
+    },
+    matrixIdentifier: {
+      type: 'string',
+    },
+    matrixDomain: {
+      type: 'string',
+    },
+  },
+  required: ['matrixAssetId', 'matrixIdentifier'],
+});
+export type MatrixAssetType = typeof MatrixAssetType;

package/src/resolvableTypes/index.ts

@@ -0,0 +1 @@
+export * from './MatrixAsset';