@squiz/dx-json-schema-lib 1.16.0 → 1.21.1-alpha.10

package/src/manifest/v1/v1.json

@@ -366,6 +366,54 @@
           }
         }
       }
+    },
+    "mockedUris": {
+      "type": "object",
+      "description": "Mocked uri objects used in the preview",
+      "propertyNames": {
+        "type": "string",
+        "pattern": "^[a-z0-9_\\-]+:\\/\\/"
+      },
+      "additionalProperties": {
+        "type": "object",
+        "description": "Property for defining the mock URI object",
+        "properties": {
+          "type": {
+            "description": "An enum of 'file' or 'inline' for how the uri object is defined",
+            "enum": ["file", "inline"]
+          }
+        },
+        "required": ["type"],
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": ["file"]
+              },
+              "path": {
+                "type": "string",
+                "format": "uri-reference",
+                "description": "Path to uri object"
+              }
+            },
+            "required": ["type", "path"]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "enum": ["inline"]
+              },
+              "value": {
+                "$ref": "MatrixAssetSchema.json",
+                "description": "Inline URI object"
+              }
+            },
+            "required": ["type", "value"]
+          }
+        ]
+      }
     }
   },
 

package/src/manifest/v1/v1.ts

@@ -65,7 +65,109 @@ export type CoreSchemaMetaSchema2 =
       type?:
         | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText')
         | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText')[];
-      format?: string;
+      format?:
+        | 'date-time'
+        | 'email'
+        | 'hostname'
+        | 'ipv4'
+        | 'ipv6'
+        | 'json-pointer'
+        | 'matrix-asset-uri'
+        | 'multi-line'
+        | 'password'
+        | 'phone'
+        | 'regex'
+        | 'relative-json-pointer'
+        | 'uri-reference'
+        | 'uri-template'
+        | 'uri'
+        | 'uuid';
+      matrixAssetTypes?: (
+        | 'audioFile'
+        | 'bodycopyContainer'
+        | 'bodycopyDiv'
+        | 'calendarEventsSearchPage'
+        | 'contentContainerTemplate'
+        | 'contentTypeMarkdown'
+        | 'contentTypeNestContent'
+        | 'contentTypeRawHtml'
+        | 'contentTypeSnippet'
+        | 'contentTypeWysiwyg'
+        | 'cssFileFolder'
+        | 'cssFile'
+        | 'customForm'
+        | 'dataRecord'
+        | 'designAreaAssetLineage'
+        | 'designAreaBody'
+        | 'designAreaMenuNormal'
+        | 'designAreaNestContent'
+        | 'designCssCustomisation'
+        | 'designCss'
+        | 'designCustomisation'
+        | 'designScss'
+        | 'design'
+        | 'docx'
+        | 'excelDoc'
+        | 'file'
+        | 'folder'
+        | 'gitBridge'
+        | 'googleAnalyticsConnector'
+        | 'googleAnalyticsView'
+        | 'image'
+        | 'jsFileFolder'
+        | 'jsFile'
+        | 'jsonWebToken'
+        | 'layoutManager'
+        | 'layout'
+        | 'link'
+        | 'metadataFieldDate'
+        | 'metadataFieldRelatedAsset'
+        | 'metadataFieldSelect'
+        | 'metadataFieldText'
+        | 'metadataFieldWysiwyg'
+        | 'metadataSchema'
+        | 'metadataSection'
+        | 'newsItem'
+        | 'oauthAccountManager'
+        | 'pageAccountManager'
+        | 'pageAssetListing'
+        | 'pageCalendarEventsSearch'
+        | 'pageCalendar'
+        | 'pagePasswordReset'
+        | 'pageRemoteContent'
+        | 'pageRestResourceJs'
+        | 'pageRestResourceOauthSession'
+        | 'pageRestResourceOauthTwoLegged'
+        | 'pageRestResource'
+        | 'pageSiteMap'
+        | 'pageStandard'
+        | 'paintLayoutBodycopy'
+        | 'paintLayoutPage'
+        | 'pdfFile'
+        | 'pdf'
+        | 'persona'
+        | 'powerpointDoc'
+        | 'pptx'
+        | 'redirectPage'
+        | 'regex'
+        | 'regularExpression'
+        | 'rtfFile'
+        | 'samlAccountManager'
+        | 'saml2Acs'
+        | 'saml2Sls'
+        | 'searchPage'
+        | 'site'
+        | 'textFile'
+        | 'TriggerTypes?'
+        | 'userGroup'
+        | 'wordDoc'
+        | 'workflowSchema'
+        | 'workflowStepCondition'
+        | 'workflowStep'
+        | 'workflowStream'
+        | 'xlsx'
+        | 'xmlFile'
+      )[];
       contentMediaType?: string;
       contentEncoding?: string;
       if?: CoreSchemaMetaSchema2;
@@ -152,6 +254,7 @@ export type CoreSchemaMetaSchema5 =
  */
 export type SchemaArray1 = CoreSchemaMetaSchema5[];
 export type StringArray1 = string[];
+export type ImageAdditionalInfo = FileAdditionalInfo;
 
 export interface ComponentManifest {
   /**
@@ -211,6 +314,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
@@ -2531,7 +2656,109 @@ export interface CoreSchemaMetaSchema1 {
   type?:
     | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText')
     | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText')[];
-  format?: string;
+  format?:
+    | 'date-time'
+    | 'email'
+    | 'hostname'
+    | 'ipv4'
+    | 'ipv6'
+    | 'json-pointer'
+    | 'matrix-asset-uri'
+    | 'multi-line'
+    | 'password'
+    | 'phone'
+    | 'regex'
+    | 'relative-json-pointer'
+    | 'uri-reference'
+    | 'uri-template'
+    | 'uri'
+    | 'uuid';
+  matrixAssetTypes?: (
+    | 'audioFile'
+    | 'bodycopyContainer'
+    | 'bodycopyDiv'
+    | 'calendarEventsSearchPage'
+    | 'contentContainerTemplate'
+    | 'contentTypeMarkdown'
+    | 'contentTypeNestContent'
+    | 'contentTypeRawHtml'
+    | 'contentTypeSnippet'
+    | 'contentTypeWysiwyg'
+    | 'cssFileFolder'
+    | 'cssFile'
+    | 'customForm'
+    | 'dataRecord'
+    | 'designAreaAssetLineage'
+    | 'designAreaBody'
+    | 'designAreaMenuNormal'
+    | 'designAreaNestContent'
+    | 'designCssCustomisation'
+    | 'designCss'
+    | 'designCustomisation'
+    | 'designScss'
+    | 'design'
+    | 'docx'
+    | 'excelDoc'
+    | 'file'
+    | 'folder'
+    | 'gitBridge'
+    | 'googleAnalyticsConnector'
+    | 'googleAnalyticsView'
+    | 'image'
+    | 'jsFileFolder'
+    | 'jsFile'
+    | 'jsonWebToken'
+    | 'layoutManager'
+    | 'layout'
+    | 'link'
+    | 'metadataFieldDate'
+    | 'metadataFieldRelatedAsset'
+    | 'metadataFieldSelect'
+    | 'metadataFieldText'
+    | 'metadataFieldWysiwyg'
+    | 'metadataSchema'
+    | 'metadataSection'
+    | 'newsItem'
+    | 'oauthAccountManager'
+    | 'pageAccountManager'
+    | 'pageAssetListing'
+    | 'pageCalendarEventsSearch'
+    | 'pageCalendar'
+    | 'pagePasswordReset'
+    | 'pageRemoteContent'
+    | 'pageRestResourceJs'
+    | 'pageRestResourceOauthSession'
+    | 'pageRestResourceOauthTwoLegged'
+    | 'pageRestResource'
+    | 'pageSiteMap'
+    | 'pageStandard'
+    | 'paintLayoutBodycopy'
+    | 'paintLayoutPage'
+    | 'pdfFile'
+    | 'pdf'
+    | 'persona'
+    | 'powerpointDoc'
+    | 'pptx'
+    | 'redirectPage'
+    | 'regex'
+    | 'regularExpression'
+    | 'rtfFile'
+    | 'samlAccountManager'
+    | 'saml2Acs'
+    | 'saml2Sls'
+    | 'searchPage'
+    | 'site'
+    | 'textFile'
+    | 'TriggerTypes?'
+    | 'userGroup'
+    | 'wordDoc'
+    | 'workflowSchema'
+    | 'workflowStepCondition'
+    | 'workflowStep'
+    | 'workflowStream'
+    | 'xlsx'
+    | 'xmlFile'
+  )[];
   contentMediaType?: string;
   contentEncoding?: string;
   if?: CoreSchemaMetaSchema2;
@@ -2728,3 +2955,414 @@ 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 CalendarEventAdditionalInfo {
+  event_info?: {
+    duration?: number;
+    frequency?: string;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+}