@chili-publish/studio-sdk 1.43.0 → 1.44.0

package/lib/src/types/ConfigurationTypes.cjs.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+var WellKnownConfigurationKeys = /* @__PURE__ */ ((WellKnownConfigurationKeys2) => {
+  WellKnownConfigurationKeys2["GraFxStudioEnvironmentApiUrl"] = "ENVIRONMENT_API";
+  WellKnownConfigurationKeys2["GraFxStudioSdkVersion"] = "SDK_VERSION";
+  WellKnownConfigurationKeys2["GraFxStudioDocumentType"] = "DOCUMENT_TYPE";
+  WellKnownConfigurationKeys2["GraFxStudioTemplateId"] = "TEMPLATE_ID";
+  WellKnownConfigurationKeys2["GraFxStudioAuthToken"] = "GRAFX_AUTH_TOKEN";
+  WellKnownConfigurationKeys2["QueryCallCacheEnabled"] = "ENABLE_QUERY_CALL_CACHE";
+  return WellKnownConfigurationKeys2;
+})(WellKnownConfigurationKeys || {});
+var FrameEditingMode = /* @__PURE__ */ ((FrameEditingMode2) => {
+  FrameEditingMode2["full"] = "full";
+  FrameEditingMode2["followConstraints"] = "followConstraints";
+  return FrameEditingMode2;
+})(FrameEditingMode || {});
+const defaultStudioOptions = {
+  shortcutOptions: {
+    debugPanel: { enabled: false },
+    ellipse: { enabled: false },
+    hand: { enabled: false },
+    temporaryHand: { enabled: false },
+    image: { enabled: false },
+    polygon: { enabled: false },
+    rectangle: { enabled: false },
+    select: { enabled: false },
+    text: { enabled: false },
+    zoom: { enabled: false },
+    copyPaste: { enabled: false },
+    viewMode: { enabled: false },
+    componentGrid: { enabled: false }
+  },
+  frameEditingMode: "full"
+  /* full */
+};
+exports.FrameEditingMode = FrameEditingMode;
+exports.WellKnownConfigurationKeys = WellKnownConfigurationKeys;
+exports.defaultStudioOptions = defaultStudioOptions;
+//# sourceMappingURL=ConfigurationTypes.cjs.js.map

package/lib/src/types/ConfigurationTypes.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurationTypes.cjs.js","sources":["../../../src/types/ConfigurationTypes.ts"],"sourcesContent":["export enum WellKnownConfigurationKeys {\n    GraFxStudioEnvironmentApiUrl = 'ENVIRONMENT_API',\n    GraFxStudioSdkVersion = 'SDK_VERSION',\n    GraFxStudioDocumentType = 'DOCUMENT_TYPE',\n    GraFxStudioTemplateId = 'TEMPLATE_ID',\n    GraFxStudioAuthToken = 'GRAFX_AUTH_TOKEN',\n    QueryCallCacheEnabled = 'ENABLE_QUERY_CALL_CACHE',\n}\n\nexport enum FrameEditingMode {\n    /**\n     * Default (Designer) mode\n     * No constraints\n     */\n    full = 'full',\n\n    /**\n     * End user mode\n     * Limits the existing tools to the given constraints\n     */\n    followConstraints = 'followConstraints',\n}\n\nexport type StudioStyling = {\n    uiBackgroundColorHex?: string;\n};\n\n/**\n * Studio Options that can be updated.\n */\nexport type StudioOptionsDeltaUpdate = {\n    /** Options for the different studio engine shortcuts */\n    shortcutOptions?: ShortcutOptionsDeltaUpdate;\n    /**\n     * Determines which editing mode should be allowed\n     * @defaultValue `FrameEditingMode.full`\n     */\n    frameEditingMode?: FrameEditingMode;\n};\n\n/**\n * Shortcut Options that can be updated.\n */\nexport type ShortcutOptionsDeltaUpdate = {\n    /** The debug panel shortcut. */\n    debugPanel?: ShortcutOption;\n\n    /** The ellipse shape shortcut. */\n    ellipse?: ShortcutOption;\n\n    /** The hand shortcut. */\n    hand?: ShortcutOption;\n\n    /** The temporary hand shortcut. */\n    temporaryHand?: ShortcutOption;\n\n    /** The image frame shortcut. */\n    image?: ShortcutOption;\n\n    /** The polygon shape shortcut. */\n    polygon?: ShortcutOption;\n\n    /** The rectangle shape shortcut. */\n    rectangle?: ShortcutOption;\n\n    /** The select shortcut. */\n    select?: ShortcutOption;\n\n    /** The text frame shortcut. */\n    text?: ShortcutOption;\n\n    /** The zoom shortcut. */\n    zoom?: ShortcutOption;\n\n    /** The copy/cut/paste/duplicate shortcut. */\n    copyPaste?: ShortcutOption;\n\n    /** The view mode shortcut. */\n    viewMode?: ShortcutOption;\n\n    /** The component grid shortcut. */\n    componentGrid?: ShortcutOption;\n};\n\n/**\n * Specific shortcut options\n */\nexport type ShortcutOption = {\n    /** Whether the shortcut is enabled. */\n    enabled: boolean;\n};\n\n/**\n * Default studio options with all shortcuts disabled.\n */\nexport const defaultStudioOptions: StudioOptionsDeltaUpdate = {\n    shortcutOptions: {\n        debugPanel: { enabled: false },\n        ellipse: { enabled: false },\n        hand: { enabled: false },\n        temporaryHand: { enabled: false },\n        image: { enabled: false },\n        polygon: { enabled: false },\n        rectangle: { enabled: false },\n        select: { enabled: false },\n        text: { enabled: false },\n        zoom: { enabled: false },\n        copyPaste: { enabled: false },\n        viewMode: { enabled: false },\n        componentGrid: { enabled: false },\n    },\n    frameEditingMode: FrameEditingMode.full,\n};\n"],"names":["WellKnownConfigurationKeys","FrameEditingMode"],"mappings":";;AAAO,IAAK,+CAAAA,gCAAL;AACHA,8BAAA,8BAAA,IAA+B;AAC/BA,8BAAA,uBAAA,IAAwB;AACxBA,8BAAA,yBAAA,IAA0B;AAC1BA,8BAAA,uBAAA,IAAwB;AACxBA,8BAAA,sBAAA,IAAuB;AACvBA,8BAAA,uBAAA,IAAwB;AANhB,SAAAA;AAAA,GAAA,8BAAA,CAAA,CAAA;AASL,IAAK,qCAAAC,sBAAL;AAKHA,oBAAA,MAAA,IAAO;AAMPA,oBAAA,mBAAA,IAAoB;AAXZ,SAAAA;AAAA,GAAA,oBAAA,CAAA,CAAA;AAsFL,MAAM,uBAAiD;AAAA,EAC1D,iBAAiB;AAAA,IACb,YAAY,EAAE,SAAS,MAAA;AAAA,IACvB,SAAS,EAAE,SAAS,MAAA;AAAA,IACpB,MAAM,EAAE,SAAS,MAAA;AAAA,IACjB,eAAe,EAAE,SAAS,MAAA;AAAA,IAC1B,OAAO,EAAE,SAAS,MAAA;AAAA,IAClB,SAAS,EAAE,SAAS,MAAA;AAAA,IACpB,WAAW,EAAE,SAAS,MAAA;AAAA,IACtB,QAAQ,EAAE,SAAS,MAAA;AAAA,IACnB,MAAM,EAAE,SAAS,MAAA;AAAA,IACjB,MAAM,EAAE,SAAS,MAAA;AAAA,IACjB,WAAW,EAAE,SAAS,MAAA;AAAA,IACtB,UAAU,EAAE,SAAS,MAAA;AAAA,IACrB,eAAe,EAAE,SAAS,MAAA;AAAA,EAAM;AAAA,EAEpC,kBAAkB;AAAA;AACtB;;;;"}

package/lib/src/types/ConfigurationTypes.d.ts

@@ -61,6 +61,8 @@ export type ShortcutOptionsDeltaUpdate = {
     copyPaste?: ShortcutOption;
     /** The view mode shortcut. */
     viewMode?: ShortcutOption;
+    /** The component grid shortcut. */
+    componentGrid?: ShortcutOption;
 };
 /**
  * Specific shortcut options

package/lib/src/types/ConfigurationTypes.es.js

@@ -0,0 +1,39 @@
+var WellKnownConfigurationKeys = /* @__PURE__ */ ((WellKnownConfigurationKeys2) => {
+  WellKnownConfigurationKeys2["GraFxStudioEnvironmentApiUrl"] = "ENVIRONMENT_API";
+  WellKnownConfigurationKeys2["GraFxStudioSdkVersion"] = "SDK_VERSION";
+  WellKnownConfigurationKeys2["GraFxStudioDocumentType"] = "DOCUMENT_TYPE";
+  WellKnownConfigurationKeys2["GraFxStudioTemplateId"] = "TEMPLATE_ID";
+  WellKnownConfigurationKeys2["GraFxStudioAuthToken"] = "GRAFX_AUTH_TOKEN";
+  WellKnownConfigurationKeys2["QueryCallCacheEnabled"] = "ENABLE_QUERY_CALL_CACHE";
+  return WellKnownConfigurationKeys2;
+})(WellKnownConfigurationKeys || {});
+var FrameEditingMode = /* @__PURE__ */ ((FrameEditingMode2) => {
+  FrameEditingMode2["full"] = "full";
+  FrameEditingMode2["followConstraints"] = "followConstraints";
+  return FrameEditingMode2;
+})(FrameEditingMode || {});
+const defaultStudioOptions = {
+  shortcutOptions: {
+    debugPanel: { enabled: false },
+    ellipse: { enabled: false },
+    hand: { enabled: false },
+    temporaryHand: { enabled: false },
+    image: { enabled: false },
+    polygon: { enabled: false },
+    rectangle: { enabled: false },
+    select: { enabled: false },
+    text: { enabled: false },
+    zoom: { enabled: false },
+    copyPaste: { enabled: false },
+    viewMode: { enabled: false },
+    componentGrid: { enabled: false }
+  },
+  frameEditingMode: "full"
+  /* full */
+};
+export {
+  FrameEditingMode,
+  WellKnownConfigurationKeys,
+  defaultStudioOptions
+};
+//# sourceMappingURL=ConfigurationTypes.es.js.map

package/lib/src/types/ConfigurationTypes.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurationTypes.es.js","sources":["../../../src/types/ConfigurationTypes.ts"],"sourcesContent":["export enum WellKnownConfigurationKeys {\n    GraFxStudioEnvironmentApiUrl = 'ENVIRONMENT_API',\n    GraFxStudioSdkVersion = 'SDK_VERSION',\n    GraFxStudioDocumentType = 'DOCUMENT_TYPE',\n    GraFxStudioTemplateId = 'TEMPLATE_ID',\n    GraFxStudioAuthToken = 'GRAFX_AUTH_TOKEN',\n    QueryCallCacheEnabled = 'ENABLE_QUERY_CALL_CACHE',\n}\n\nexport enum FrameEditingMode {\n    /**\n     * Default (Designer) mode\n     * No constraints\n     */\n    full = 'full',\n\n    /**\n     * End user mode\n     * Limits the existing tools to the given constraints\n     */\n    followConstraints = 'followConstraints',\n}\n\nexport type StudioStyling = {\n    uiBackgroundColorHex?: string;\n};\n\n/**\n * Studio Options that can be updated.\n */\nexport type StudioOptionsDeltaUpdate = {\n    /** Options for the different studio engine shortcuts */\n    shortcutOptions?: ShortcutOptionsDeltaUpdate;\n    /**\n     * Determines which editing mode should be allowed\n     * @defaultValue `FrameEditingMode.full`\n     */\n    frameEditingMode?: FrameEditingMode;\n};\n\n/**\n * Shortcut Options that can be updated.\n */\nexport type ShortcutOptionsDeltaUpdate = {\n    /** The debug panel shortcut. */\n    debugPanel?: ShortcutOption;\n\n    /** The ellipse shape shortcut. */\n    ellipse?: ShortcutOption;\n\n    /** The hand shortcut. */\n    hand?: ShortcutOption;\n\n    /** The temporary hand shortcut. */\n    temporaryHand?: ShortcutOption;\n\n    /** The image frame shortcut. */\n    image?: ShortcutOption;\n\n    /** The polygon shape shortcut. */\n    polygon?: ShortcutOption;\n\n    /** The rectangle shape shortcut. */\n    rectangle?: ShortcutOption;\n\n    /** The select shortcut. */\n    select?: ShortcutOption;\n\n    /** The text frame shortcut. */\n    text?: ShortcutOption;\n\n    /** The zoom shortcut. */\n    zoom?: ShortcutOption;\n\n    /** The copy/cut/paste/duplicate shortcut. */\n    copyPaste?: ShortcutOption;\n\n    /** The view mode shortcut. */\n    viewMode?: ShortcutOption;\n\n    /** The component grid shortcut. */\n    componentGrid?: ShortcutOption;\n};\n\n/**\n * Specific shortcut options\n */\nexport type ShortcutOption = {\n    /** Whether the shortcut is enabled. */\n    enabled: boolean;\n};\n\n/**\n * Default studio options with all shortcuts disabled.\n */\nexport const defaultStudioOptions: StudioOptionsDeltaUpdate = {\n    shortcutOptions: {\n        debugPanel: { enabled: false },\n        ellipse: { enabled: false },\n        hand: { enabled: false },\n        temporaryHand: { enabled: false },\n        image: { enabled: false },\n        polygon: { enabled: false },\n        rectangle: { enabled: false },\n        select: { enabled: false },\n        text: { enabled: false },\n        zoom: { enabled: false },\n        copyPaste: { enabled: false },\n        viewMode: { enabled: false },\n        componentGrid: { enabled: false },\n    },\n    frameEditingMode: FrameEditingMode.full,\n};\n"],"names":["WellKnownConfigurationKeys","FrameEditingMode"],"mappings":"AAAO,IAAK,+CAAAA,gCAAL;AACHA,8BAAA,8BAAA,IAA+B;AAC/BA,8BAAA,uBAAA,IAAwB;AACxBA,8BAAA,yBAAA,IAA0B;AAC1BA,8BAAA,uBAAA,IAAwB;AACxBA,8BAAA,sBAAA,IAAuB;AACvBA,8BAAA,uBAAA,IAAwB;AANhB,SAAAA;AAAA,GAAA,8BAAA,CAAA,CAAA;AASL,IAAK,qCAAAC,sBAAL;AAKHA,oBAAA,MAAA,IAAO;AAMPA,oBAAA,mBAAA,IAAoB;AAXZ,SAAAA;AAAA,GAAA,oBAAA,CAAA,CAAA;AAsFL,MAAM,uBAAiD;AAAA,EAC1D,iBAAiB;AAAA,IACb,YAAY,EAAE,SAAS,MAAA;AAAA,IACvB,SAAS,EAAE,SAAS,MAAA;AAAA,IACpB,MAAM,EAAE,SAAS,MAAA;AAAA,IACjB,eAAe,EAAE,SAAS,MAAA;AAAA,IAC1B,OAAO,EAAE,SAAS,MAAA;AAAA,IAClB,SAAS,EAAE,SAAS,MAAA;AAAA,IACpB,WAAW,EAAE,SAAS,MAAA;AAAA,IACtB,QAAQ,EAAE,SAAS,MAAA;AAAA,IACnB,MAAM,EAAE,SAAS,MAAA;AAAA,IACjB,MAAM,EAAE,SAAS,MAAA;AAAA,IACjB,WAAW,EAAE,SAAS,MAAA;AAAA,IACtB,UAAU,EAAE,SAAS,MAAA;AAAA,IACrB,eAAe,EAAE,SAAS,MAAA;AAAA,EAAM;AAAA,EAEpC,kBAAkB;AAAA;AACtB;"}

package/lib/src/types/ConnectorTypes.cjs.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+var DeprecatedMediaType = /* @__PURE__ */ ((DeprecatedMediaType2) => {
+  DeprecatedMediaType2[DeprecatedMediaType2["file"] = 0] = "file";
+  DeprecatedMediaType2[DeprecatedMediaType2["collection"] = 1] = "collection";
+  return DeprecatedMediaType2;
+})(DeprecatedMediaType || {});
+var DeprecatedMediaConnectorDownloadType = /* @__PURE__ */ ((DeprecatedMediaConnectorDownloadType2) => {
+  DeprecatedMediaConnectorDownloadType2["LowResolutionWeb"] = "lowresWeb";
+  DeprecatedMediaConnectorDownloadType2["HighResolutionWeb"] = "highresWeb";
+  return DeprecatedMediaConnectorDownloadType2;
+})(DeprecatedMediaConnectorDownloadType || {});
+var MediaType = /* @__PURE__ */ ((MediaType2) => {
+  MediaType2["file"] = "file";
+  MediaType2["collection"] = "collection";
+  return MediaType2;
+})(MediaType || {});
+var ConnectorType = /* @__PURE__ */ ((ConnectorType2) => {
+  ConnectorType2["media"] = "media";
+  ConnectorType2["fonts"] = "fonts";
+  ConnectorType2["data"] = "data";
+  ConnectorType2["components"] = "components";
+  return ConnectorType2;
+})(ConnectorType || {});
+var SortBy = /* @__PURE__ */ ((SortBy2) => {
+  SortBy2["name"] = "name";
+  SortBy2["path"] = "relativePath";
+  SortBy2["id"] = "id";
+  return SortBy2;
+})(SortBy || {});
+var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
+  SortOrder2["ascending"] = "asc";
+  SortOrder2["descending"] = "desc";
+  return SortOrder2;
+})(SortOrder || {});
+var ConnectorConfigValueType = /* @__PURE__ */ ((ConnectorConfigValueType2) => {
+  ConnectorConfigValueType2["text"] = "text";
+  ConnectorConfigValueType2["boolean"] = "boolean";
+  ConnectorConfigValueType2["number"] = "number";
+  return ConnectorConfigValueType2;
+})(ConnectorConfigValueType || {});
+var ConnectorConfigContextType = /* @__PURE__ */ ((ConnectorConfigContextType2) => {
+  ConnectorConfigContextType2["query"] = "query";
+  ConnectorConfigContextType2["upload"] = "upload";
+  return ConnectorConfigContextType2;
+})(ConnectorConfigContextType || {});
+var ConnectorRegistrationSource = /* @__PURE__ */ ((ConnectorRegistrationSource2) => {
+  ConnectorRegistrationSource2["url"] = "url";
+  ConnectorRegistrationSource2["grafx"] = "grafx";
+  ConnectorRegistrationSource2["local"] = "local";
+  return ConnectorRegistrationSource2;
+})(ConnectorRegistrationSource || {});
+class ConnectorMapping {
+  constructor(contextProperty, mapFrom, sourceValue, direction = "engineToConnector") {
+    this.direction = "engineToConnector";
+    this.name = contextProperty;
+    this.direction = direction;
+    if (mapFrom === "var") {
+      this.value = `${mapFrom}.${sourceValue}`;
+    } else {
+      this.value = sourceValue;
+    }
+  }
+}
+var ConnectorMappingSource = /* @__PURE__ */ ((ConnectorMappingSource2) => {
+  ConnectorMappingSource2["variable"] = "var";
+  ConnectorMappingSource2["value"] = "value";
+  return ConnectorMappingSource2;
+})(ConnectorMappingSource || {});
+var ConnectorMappingDirection = /* @__PURE__ */ ((ConnectorMappingDirection2) => {
+  ConnectorMappingDirection2["engineToConnector"] = "engineToConnector";
+  ConnectorMappingDirection2["connectorToEngine"] = "connectorToEngine";
+  return ConnectorMappingDirection2;
+})(ConnectorMappingDirection || {});
+var ConnectorStateType = /* @__PURE__ */ ((ConnectorStateType2) => {
+  ConnectorStateType2["loading"] = "loading";
+  ConnectorStateType2["loaded"] = "loaded";
+  ConnectorStateType2["running"] = "running";
+  ConnectorStateType2["ready"] = "ready";
+  ConnectorStateType2["error"] = "error";
+  return ConnectorStateType2;
+})(ConnectorStateType || {});
+var ConnectorEventType = /* @__PURE__ */ ((ConnectorEventType2) => {
+  ConnectorEventType2["stateChanged"] = "stateChanged";
+  ConnectorEventType2["authChanged"] = "authChanged";
+  ConnectorEventType2["reloadRequired"] = "reloadRequired";
+  ConnectorEventType2["unloaded"] = "unloaded";
+  return ConnectorEventType2;
+})(ConnectorEventType || {});
+const grafxMediaConnectorRegistration = {
+  url: "grafx-media.json",
+  source: "local"
+  /* local */
+};
+class GrafxTokenAuthCredentials {
+  constructor(token, headers) {
+    this.type = "grafxToken";
+    this.token = token;
+    this.headers = headers;
+  }
+}
+class RefreshedAuthCredendentials {
+  constructor(headers) {
+    this.type = "refreshed";
+    this.headers = headers;
+  }
+}
+var AuthCredentialsTypeEnum = /* @__PURE__ */ ((AuthCredentialsTypeEnum2) => {
+  AuthCredentialsTypeEnum2["grafxToken"] = "grafxToken";
+  AuthCredentialsTypeEnum2["refreshed"] = "refreshed";
+  return AuthCredentialsTypeEnum2;
+})(AuthCredentialsTypeEnum || {});
+var AuthRefreshTypeEnum = /* @__PURE__ */ ((AuthRefreshTypeEnum2) => {
+  AuthRefreshTypeEnum2["grafxToken"] = "grafxToken";
+  AuthRefreshTypeEnum2["any"] = "any";
+  return AuthRefreshTypeEnum2;
+})(AuthRefreshTypeEnum || {});
+var UploadAssetValidationErrorType = /* @__PURE__ */ ((UploadAssetValidationErrorType2) => {
+  UploadAssetValidationErrorType2["minDimension"] = "minDimension";
+  return UploadAssetValidationErrorType2;
+})(UploadAssetValidationErrorType || {});
+class UploadAssetValidationError extends Error {
+  constructor(message, type) {
+    super(message);
+    this.type = type;
+  }
+}
+var ConnectorSupportedAuth = /* @__PURE__ */ ((ConnectorSupportedAuth2) => {
+  ConnectorSupportedAuth2["StaticKey"] = "staticKey";
+  ConnectorSupportedAuth2["OAuth2ClientCredentials"] = "oAuth2ClientCredentials";
+  ConnectorSupportedAuth2["OAuth2AuthorizationCode"] = "oAuth2AuthorizationCode";
+  ConnectorSupportedAuth2["OAuth2ResourceOwnerPassword"] = "oAuth2ResourceOwnerPassword";
+  ConnectorSupportedAuth2["OAuth2JwtBearer"] = "oAuth2JwtBearer";
+  ConnectorSupportedAuth2["None"] = "none";
+  return ConnectorSupportedAuth2;
+})(ConnectorSupportedAuth || {});
+exports.AuthCredentialsTypeEnum = AuthCredentialsTypeEnum;
+exports.AuthRefreshTypeEnum = AuthRefreshTypeEnum;
+exports.ConnectorConfigContextType = ConnectorConfigContextType;
+exports.ConnectorConfigValueType = ConnectorConfigValueType;
+exports.ConnectorEventType = ConnectorEventType;
+exports.ConnectorMapping = ConnectorMapping;
+exports.ConnectorMappingDirection = ConnectorMappingDirection;
+exports.ConnectorMappingSource = ConnectorMappingSource;
+exports.ConnectorRegistrationSource = ConnectorRegistrationSource;
+exports.ConnectorStateType = ConnectorStateType;
+exports.ConnectorSupportedAuth = ConnectorSupportedAuth;
+exports.ConnectorType = ConnectorType;
+exports.DeprecatedMediaConnectorDownloadType = DeprecatedMediaConnectorDownloadType;
+exports.DeprecatedMediaType = DeprecatedMediaType;
+exports.GrafxTokenAuthCredentials = GrafxTokenAuthCredentials;
+exports.MediaType = MediaType;
+exports.RefreshedAuthCredendentials = RefreshedAuthCredendentials;
+exports.SortBy = SortBy;
+exports.SortOrder = SortOrder;
+exports.UploadAssetValidationError = UploadAssetValidationError;
+exports.UploadAssetValidationErrorType = UploadAssetValidationErrorType;
+exports.grafxMediaConnectorRegistration = grafxMediaConnectorRegistration;
+//# sourceMappingURL=ConnectorTypes.cjs.js.map

package/lib/src/types/ConnectorTypes.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectorTypes.cjs.js","sources":["../../../src/types/ConnectorTypes.ts"],"sourcesContent":["import type {\n    Dictionary as ContextDictionary,\n    ConnectorConfigOptions as GenericConnectorConfigOptions,\n    ConnectorConfigValue as GenericConnectorConfigValue,\n    QueryPage as QueryResult,\n} from '@chili-studio/connector-types';\nimport { Id } from './CommonTypes';\n\nexport type { FilePointer, QueryOptions } from '@chili-studio/connector-types';\n\nexport enum DeprecatedMediaType {\n    file = 0,\n    collection = 1,\n}\n\nexport enum DeprecatedMediaConnectorDownloadType {\n    LowResolutionWeb = 'lowresWeb',\n    HighResolutionWeb = 'highresWeb',\n}\n\nexport enum MediaType {\n    file = 'file',\n    collection = 'collection',\n}\n\nexport enum ConnectorType {\n    media = 'media',\n    fonts = 'fonts',\n    data = 'data',\n    /**\n     * @experimental This is still experimental and might change in future releases.\n     */\n    components = 'components',\n}\n\nexport enum SortBy {\n    name = 'name',\n    path = 'relativePath',\n    id = 'id',\n}\n\nexport enum SortOrder {\n    ascending = 'asc',\n    descending = 'desc',\n}\n\nexport enum ConnectorConfigValueType {\n    text = 'text',\n    boolean = 'boolean',\n    number = 'number',\n}\n\nexport enum ConnectorConfigContextType {\n    query = 'query',\n    upload = 'upload',\n}\n\nexport type ConnectorConfigValue = GenericConnectorConfigValue<ConnectorConfigValueType, ConnectorConfigContextType>;\nexport type ConnectorConfigOptions = GenericConnectorConfigOptions<\n    ConnectorConfigValueType,\n    ConnectorConfigContextType\n>;\n\ninterface ConnectorRegistrationBase {\n    /**\n     * Url to the connector.\n     *\n     * - If source is `url`, this must be a publicly accessible url.\n     *\n     * - If source is `grafx`, this must be the full url to the connector GET endpoint on GraFx Environment API.\n     */\n    url: string;\n\n    /**\n     * Connector source type.\n     */\n    source: ConnectorRegistrationSource;\n}\n\nexport interface ConnectorUrlRegistration extends ConnectorRegistrationBase {\n    source: ConnectorRegistrationSource.url;\n}\n\nexport interface ConnectorGrafxRegistration extends ConnectorRegistrationBase {\n    source: ConnectorRegistrationSource.grafx;\n}\n\nexport interface ConnectorLocalRegistration extends ConnectorRegistrationBase {\n    source: ConnectorRegistrationSource.local;\n}\n\nexport type ConnectorRegistration = ConnectorUrlRegistration | ConnectorGrafxRegistration | ConnectorLocalRegistration;\n\nexport type ConnectorInstance = {\n    id: Id;\n    name: string;\n    iconUrl: string;\n    source: ConnectorRegistration;\n};\n\nexport enum ConnectorRegistrationSource {\n    /**\n     * Connector is hosted on a publicly accessible link.\n     */\n    url = 'url',\n\n    /**\n     * Connector is hosted on GraFx Environment API.\n     */\n    grafx = 'grafx',\n\n    /**\n     * Connector is embedded in the document.\n     * Note: This is a temporary type; only to be used internally.\n     */\n    local = 'local',\n}\n\nexport interface EngineToConnectorMapping {\n    name: string;\n    value: ContextDictionary[keyof ContextDictionary];\n    direction: ConnectorMappingDirection.engineToConnector;\n}\n\nexport interface ConnectorToEngineMapping {\n    name: string;\n    value: string;\n    direction: ConnectorMappingDirection.connectorToEngine;\n}\n\nexport type ConnectorMappingType = EngineToConnectorMapping | ConnectorToEngineMapping;\n\nexport class ConnectorMapping implements EngineToConnectorMapping, ConnectorToEngineMapping {\n    name: string;\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    value: any;\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    direction: any = ConnectorMappingDirection.engineToConnector;\n\n    constructor(\n        contextProperty: string,\n        mapFrom: ConnectorMappingSource.variable,\n        sourceValue: string,\n        direction: ConnectorMappingDirection.connectorToEngine,\n    );\n    constructor(\n        contextProperty: string,\n        mapFrom: ConnectorMappingSource,\n        sourceValue: string | boolean | number,\n        direction?: ConnectorMappingDirection.engineToConnector,\n    );\n    constructor(contextProperty: string, mapFrom: ConnectorMappingSource, sourceValue: string | boolean | number);\n    constructor(\n        contextProperty: string,\n        mapFrom: ConnectorMappingSource,\n        sourceValue: string | boolean | number,\n        direction = ConnectorMappingDirection.engineToConnector,\n    ) {\n        this.name = contextProperty;\n        this.direction = direction;\n\n        if (mapFrom === ConnectorMappingSource.variable) {\n            this.value = `${mapFrom}.${sourceValue}`;\n        } else {\n            this.value = sourceValue;\n        }\n    }\n}\n\nexport type ConnectorState = {\n    id: Id;\n    type: ConnectorStateType;\n};\n\nexport type ConnectorEvent = {\n    id: Id;\n    type: ConnectorEventType;\n};\n\nexport type QueryPage<T> = Omit<QueryResult<T>, 'links'> & {\n    nextPageToken?: string;\n};\n\nexport enum ConnectorMappingSource {\n    variable = 'var',\n    value = 'value',\n}\n\n/**\n * Direction of the Connector Mapping.\n */\nexport enum ConnectorMappingDirection {\n    /**\n     * Indicates the mapping will propagate a value to the connector. This\n     * mapping might cause the linked connector to refresh.\n     */\n    engineToConnector = 'engineToConnector',\n\n    /**\n     * Indicates the mapping will propagate a value from inside the connector\n     * to the engine. AKA \"reverse mapping\".\n     */\n    connectorToEngine = 'connectorToEngine',\n}\n\nexport enum ConnectorStateType {\n    /**\n     * Connector loading process has started.\n     * Any SDK methods that required the connector id, will start working now.\n     */\n    loading = 'loading',\n\n    /**\n     * Connector loading completed.\n     */\n    loaded = 'loaded',\n\n    /**\n     * Connector is running in QuickJS.\n     */\n\n    running = 'running',\n\n    /**\n     * Connector is fully configured and has the correct authentication information.\n     * At this point the connector is ready to make requests.\n     */\n    ready = 'ready',\n\n    /**\n     * Something went wrong, the connector is in error state.\n     * Check the error message for more information.\n     */\n    error = 'error',\n}\n\nexport enum ConnectorEventType {\n    /**\n     * This event will be triggered by the following state changes of the connector\n     * - loading\n     * - loaded\n     * - running\n     * - ready\n     * - error\n     */\n    stateChanged = 'stateChanged',\n\n    /**\n     * Authentication information is changed\n     */\n    authChanged = 'authChanged',\n\n    /**\n     * Connector configuration changed that requires the connector to be reloaded in QuickJS.\n     * This will trigger multiple 'stateChanged' events while it is reloading.\n     * Wait until 'ready'-stateChanged event is received to start using the connector again.\n     */\n    reloadRequired = 'reloadRequired',\n\n    /**\n     * Connector is unregistered and no longer exists inside the editor engine.\n     * Don't use the 'connectorId' after receiving this event.\n     */\n    unloaded = 'unloaded',\n}\n\n/**\n * Hardcoded grafx media connector until we get it from the environment.\n */\nexport const grafxMediaConnectorRegistration: ConnectorLocalRegistration = {\n    url: 'grafx-media.json',\n    source: ConnectorRegistrationSource.local,\n};\n\n/**\n * Grafx token to return to the engine when it expires.\n */\nexport class GrafxTokenAuthCredentials {\n    token: string;\n    type = AuthCredentialsTypeEnum.grafxToken;\n    /**\n     * Optional HTTP headers to send with connector requests (e.g. Authorization).\n     */\n    headers?: Record<string, string>;\n\n    constructor(token: string, headers?: Record<string, string>) {\n        this.token = token;\n        this.headers = headers;\n    }\n}\n\n/**\n * Notification to return to the engine whenever a 3rd party auth (user impersonation)\n * has been renewed by the integration.\n */\nexport class RefreshedAuthCredendentials {\n    type = AuthCredentialsTypeEnum.refreshed;\n    /**\n     * Optional HTTP headers to send with connector requests (e.g. Authorization).\n     */\n    headers?: Record<string, string>;\n\n    constructor(headers?: Record<string, string>) {\n        this.headers = headers;\n    }\n}\n\nexport enum AuthCredentialsTypeEnum {\n    grafxToken = 'grafxToken',\n    refreshed = 'refreshed',\n}\n\nexport type AuthCredentials = GrafxTokenAuthCredentials | RefreshedAuthCredendentials;\n\nexport enum AuthRefreshTypeEnum {\n    grafxToken = 'grafxToken',\n    any = 'any',\n}\n\nexport type GrafxAuthRefreshRequest = {\n    type: AuthRefreshTypeEnum.grafxToken;\n};\n\n/**\n * @param connectorId connector id\n * @param remoteConnectorId remote connector id\n * @param headerValue the value of the X-GRAFX-UNAUTHORIZED header. This\n *      will notify that the dam authentication expired if it went through the\n *      proxy.\n *      Example: \"Static, 1234\", \"OAuthClientCredentials, 5678\"\n *      If the http request did not go through the proxy, headerValue is null.\n */\nexport type AnyAuthRefreshRequest = {\n    type: AuthRefreshTypeEnum.any;\n    connectorId: Id;\n    remoteConnectorId: Id;\n    headerValue: string | null;\n    connectorDefinition: ConnectorDefinition;\n};\n\nexport type AuthRefreshRequest = GrafxAuthRefreshRequest | AnyAuthRefreshRequest;\n\nexport type ConnectorOptions = ContextDictionary;\nexport type MetaData = ContextDictionary;\n\nexport type UploadValidationConfiguration = {\n    minWidthPixels?: number | null;\n    maxWidthPixels?: number | null;\n    minHeightPixels?: number | null;\n    maxHeightPixels?: number | null;\n    mimeTypes?: string[];\n};\n\nexport enum UploadAssetValidationErrorType {\n    minDimension = 'minDimension',\n}\n\nexport class UploadAssetValidationError extends Error {\n    constructor(message: string, public type: UploadAssetValidationErrorType) {\n        super(message);\n    }\n}\n\nexport enum ConnectorSupportedAuth {\n    StaticKey = 'staticKey',\n    OAuth2ClientCredentials = 'oAuth2ClientCredentials',\n    OAuth2AuthorizationCode = 'oAuth2AuthorizationCode',\n    OAuth2ResourceOwnerPassword = 'oAuth2ResourceOwnerPassword',\n    OAuth2JwtBearer = 'oAuth2JwtBearer',\n    None = 'none',\n}\n\ninterface ConnectorDefinition {\n    id: Id;\n    name: string;\n    type: ConnectorType;\n    supportedAuthentication: { browser: ConnectorSupportedAuth[]; server: ConnectorSupportedAuth[] };\n    externalSourceId?: string | null;\n}\n"],"names":["DeprecatedMediaType","DeprecatedMediaConnectorDownloadType","MediaType","ConnectorType","SortBy","SortOrder","ConnectorConfigValueType","ConnectorConfigContextType","ConnectorRegistrationSource","ConnectorMappingSource","ConnectorMappingDirection","ConnectorStateType","ConnectorEventType","AuthCredentialsTypeEnum","AuthRefreshTypeEnum","UploadAssetValidationErrorType","ConnectorSupportedAuth"],"mappings":";;AAUO,IAAK,wCAAAA,yBAAL;AACHA,uBAAAA,qBAAA,UAAO,CAAA,IAAP;AACAA,uBAAAA,qBAAA,gBAAa,CAAA,IAAb;AAFQ,SAAAA;AAAA,GAAA,uBAAA,CAAA,CAAA;AAKL,IAAK,yDAAAC,0CAAL;AACHA,wCAAA,kBAAA,IAAmB;AACnBA,wCAAA,mBAAA,IAAoB;AAFZ,SAAAA;AAAA,GAAA,wCAAA,CAAA,CAAA;AAKL,IAAK,8BAAAC,eAAL;AACHA,aAAA,MAAA,IAAO;AACPA,aAAA,YAAA,IAAa;AAFL,SAAAA;AAAA,GAAA,aAAA,CAAA,CAAA;AAKL,IAAK,kCAAAC,mBAAL;AACHA,iBAAA,OAAA,IAAQ;AACRA,iBAAA,OAAA,IAAQ;AACRA,iBAAA,MAAA,IAAO;AAIPA,iBAAA,YAAA,IAAa;AAPL,SAAAA;AAAA,GAAA,iBAAA,CAAA,CAAA;AAUL,IAAK,2BAAAC,YAAL;AACHA,UAAA,MAAA,IAAO;AACPA,UAAA,MAAA,IAAO;AACPA,UAAA,IAAA,IAAK;AAHG,SAAAA;AAAA,GAAA,UAAA,CAAA,CAAA;AAML,IAAK,8BAAAC,eAAL;AACHA,aAAA,WAAA,IAAY;AACZA,aAAA,YAAA,IAAa;AAFL,SAAAA;AAAA,GAAA,aAAA,CAAA,CAAA;AAKL,IAAK,6CAAAC,8BAAL;AACHA,4BAAA,MAAA,IAAO;AACPA,4BAAA,SAAA,IAAU;AACVA,4BAAA,QAAA,IAAS;AAHD,SAAAA;AAAA,GAAA,4BAAA,CAAA,CAAA;AAML,IAAK,+CAAAC,gCAAL;AACHA,8BAAA,OAAA,IAAQ;AACRA,8BAAA,QAAA,IAAS;AAFD,SAAAA;AAAA,GAAA,8BAAA,CAAA,CAAA;AAgDL,IAAK,gDAAAC,iCAAL;AAIHA,+BAAA,KAAA,IAAM;AAKNA,+BAAA,OAAA,IAAQ;AAMRA,+BAAA,OAAA,IAAQ;AAfA,SAAAA;AAAA,GAAA,+BAAA,CAAA,CAAA;AAgCL,MAAM,iBAA+E;AAAA,EAoBxF,YACI,iBACA,SACA,aACA,YAAY,qBACd;AApBF,SAAA,YAAiB;AAqBb,SAAK,OAAO;AACZ,SAAK,YAAY;AAEjB,QAAI,YAAY,OAAiC;AAC7C,WAAK,QAAQ,GAAG,OAAO,IAAI,WAAW;AAAA,IAC1C,OAAO;AACH,WAAK,QAAQ;AAAA,IACjB;AAAA,EACJ;AACJ;AAgBO,IAAK,2CAAAC,4BAAL;AACHA,0BAAA,UAAA,IAAW;AACXA,0BAAA,OAAA,IAAQ;AAFA,SAAAA;AAAA,GAAA,0BAAA,CAAA,CAAA;AAQL,IAAK,8CAAAC,+BAAL;AAKHA,6BAAA,mBAAA,IAAoB;AAMpBA,6BAAA,mBAAA,IAAoB;AAXZ,SAAAA;AAAA,GAAA,6BAAA,CAAA,CAAA;AAcL,IAAK,uCAAAC,wBAAL;AAKHA,sBAAA,SAAA,IAAU;AAKVA,sBAAA,QAAA,IAAS;AAMTA,sBAAA,SAAA,IAAU;AAMVA,sBAAA,OAAA,IAAQ;AAMRA,sBAAA,OAAA,IAAQ;AA5BA,SAAAA;AAAA,GAAA,sBAAA,CAAA,CAAA;AA+BL,IAAK,uCAAAC,wBAAL;AASHA,sBAAA,cAAA,IAAe;AAKfA,sBAAA,aAAA,IAAc;AAOdA,sBAAA,gBAAA,IAAiB;AAMjBA,sBAAA,UAAA,IAAW;AA3BH,SAAAA;AAAA,GAAA,sBAAA,CAAA,CAAA;AAiCL,MAAM,kCAA8D;AAAA,EACvE,KAAK;AAAA,EACL,QAAQ;AAAA;AACZ;AAKO,MAAM,0BAA0B;AAAA,EAQnC,YAAY,OAAe,SAAkC;AAN7D,SAAA,OAAO;AAOH,SAAK,QAAQ;AACb,SAAK,UAAU;AAAA,EACnB;AACJ;AAMO,MAAM,4BAA4B;AAAA,EAOrC,YAAY,SAAkC;AAN9C,SAAA,OAAO;AAOH,SAAK,UAAU;AAAA,EACnB;AACJ;AAEO,IAAK,4CAAAC,6BAAL;AACHA,2BAAA,YAAA,IAAa;AACbA,2BAAA,WAAA,IAAY;AAFJ,SAAAA;AAAA,GAAA,2BAAA,CAAA,CAAA;AAOL,IAAK,wCAAAC,yBAAL;AACHA,uBAAA,YAAA,IAAa;AACbA,uBAAA,KAAA,IAAM;AAFE,SAAAA;AAAA,GAAA,uBAAA,CAAA,CAAA;AAuCL,IAAK,mDAAAC,oCAAL;AACHA,kCAAA,cAAA,IAAe;AADP,SAAAA;AAAA,GAAA,kCAAA,CAAA,CAAA;AAIL,MAAM,mCAAmC,MAAM;AAAA,EAClD,YAAY,SAAwB,MAAsC;AACtE,UAAM,OAAO;AADmB,SAAA,OAAA;AAAA,EAEpC;AACJ;AAEO,IAAK,2CAAAC,4BAAL;AACHA,0BAAA,WAAA,IAAY;AACZA,0BAAA,yBAAA,IAA0B;AAC1BA,0BAAA,yBAAA,IAA0B;AAC1BA,0BAAA,6BAAA,IAA8B;AAC9BA,0BAAA,iBAAA,IAAkB;AAClBA,0BAAA,MAAA,IAAO;AANC,SAAAA;AAAA,GAAA,0BAAA,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;"}

package/lib/src/types/ConnectorTypes.d.ts

@@ -33,7 +33,8 @@ export declare enum SortOrder {
 }
 export declare enum ConnectorConfigValueType {
     text = "text",
-    boolean = "boolean"
+    boolean = "boolean",
+    number = "number"
 }
 export declare enum ConnectorConfigContextType {
     query = "query",
@@ -102,8 +103,8 @@ export declare class ConnectorMapping implements EngineToConnectorMapping, Conne
     value: any;
     direction: any;
     constructor(contextProperty: string, mapFrom: ConnectorMappingSource.variable, sourceValue: string, direction: ConnectorMappingDirection.connectorToEngine);
-    constructor(contextProperty: string, mapFrom: ConnectorMappingSource, sourceValue: string | boolean, direction?: ConnectorMappingDirection.engineToConnector);
-    constructor(contextProperty: string, mapFrom: ConnectorMappingSource, sourceValue: string | boolean);
+    constructor(contextProperty: string, mapFrom: ConnectorMappingSource, sourceValue: string | boolean | number, direction?: ConnectorMappingDirection.engineToConnector);
+    constructor(contextProperty: string, mapFrom: ConnectorMappingSource, sourceValue: string | boolean | number);
 }
 export type ConnectorState = {
     id: Id;
@@ -223,23 +224,26 @@ export declare enum AuthRefreshTypeEnum {
     grafxToken = "grafxToken",
     any = "any"
 }
+export type GrafxAuthRefreshRequest = {
+    type: AuthRefreshTypeEnum.grafxToken;
+};
 /**
  * @param connectorId connector id
  * @param remoteConnectorId remote connector id
- * @param type type of auth renewal needed
  * @param headerValue the value of the X-GRAFX-UNAUTHORIZED header. This
  *      will notify that the dam authentication expired if it went through the
  *      proxy.
  *      Example: "Static, 1234", "OAuthClientCredentials, 5678"
  *      If the http request did not go through the proxy, headerValue is null.
  */
-export type AuthRefreshRequest = {
+export type AnyAuthRefreshRequest = {
+    type: AuthRefreshTypeEnum.any;
     connectorId: Id;
     remoteConnectorId: Id;
-    type: AuthRefreshTypeEnum;
     headerValue: string | null;
     connectorDefinition: ConnectorDefinition;
 };
+export type AuthRefreshRequest = GrafxAuthRefreshRequest | AnyAuthRefreshRequest;
 export type ConnectorOptions = ContextDictionary;
 export type MetaData = ContextDictionary;
 export type UploadValidationConfiguration = {

package/lib/src/types/ConnectorTypes.es.js

@@ -0,0 +1,159 @@
+var DeprecatedMediaType = /* @__PURE__ */ ((DeprecatedMediaType2) => {
+  DeprecatedMediaType2[DeprecatedMediaType2["file"] = 0] = "file";
+  DeprecatedMediaType2[DeprecatedMediaType2["collection"] = 1] = "collection";
+  return DeprecatedMediaType2;
+})(DeprecatedMediaType || {});
+var DeprecatedMediaConnectorDownloadType = /* @__PURE__ */ ((DeprecatedMediaConnectorDownloadType2) => {
+  DeprecatedMediaConnectorDownloadType2["LowResolutionWeb"] = "lowresWeb";
+  DeprecatedMediaConnectorDownloadType2["HighResolutionWeb"] = "highresWeb";
+  return DeprecatedMediaConnectorDownloadType2;
+})(DeprecatedMediaConnectorDownloadType || {});
+var MediaType = /* @__PURE__ */ ((MediaType2) => {
+  MediaType2["file"] = "file";
+  MediaType2["collection"] = "collection";
+  return MediaType2;
+})(MediaType || {});
+var ConnectorType = /* @__PURE__ */ ((ConnectorType2) => {
+  ConnectorType2["media"] = "media";
+  ConnectorType2["fonts"] = "fonts";
+  ConnectorType2["data"] = "data";
+  ConnectorType2["components"] = "components";
+  return ConnectorType2;
+})(ConnectorType || {});
+var SortBy = /* @__PURE__ */ ((SortBy2) => {
+  SortBy2["name"] = "name";
+  SortBy2["path"] = "relativePath";
+  SortBy2["id"] = "id";
+  return SortBy2;
+})(SortBy || {});
+var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
+  SortOrder2["ascending"] = "asc";
+  SortOrder2["descending"] = "desc";
+  return SortOrder2;
+})(SortOrder || {});
+var ConnectorConfigValueType = /* @__PURE__ */ ((ConnectorConfigValueType2) => {
+  ConnectorConfigValueType2["text"] = "text";
+  ConnectorConfigValueType2["boolean"] = "boolean";
+  ConnectorConfigValueType2["number"] = "number";
+  return ConnectorConfigValueType2;
+})(ConnectorConfigValueType || {});
+var ConnectorConfigContextType = /* @__PURE__ */ ((ConnectorConfigContextType2) => {
+  ConnectorConfigContextType2["query"] = "query";
+  ConnectorConfigContextType2["upload"] = "upload";
+  return ConnectorConfigContextType2;
+})(ConnectorConfigContextType || {});
+var ConnectorRegistrationSource = /* @__PURE__ */ ((ConnectorRegistrationSource2) => {
+  ConnectorRegistrationSource2["url"] = "url";
+  ConnectorRegistrationSource2["grafx"] = "grafx";
+  ConnectorRegistrationSource2["local"] = "local";
+  return ConnectorRegistrationSource2;
+})(ConnectorRegistrationSource || {});
+class ConnectorMapping {
+  constructor(contextProperty, mapFrom, sourceValue, direction = "engineToConnector") {
+    this.direction = "engineToConnector";
+    this.name = contextProperty;
+    this.direction = direction;
+    if (mapFrom === "var") {
+      this.value = `${mapFrom}.${sourceValue}`;
+    } else {
+      this.value = sourceValue;
+    }
+  }
+}
+var ConnectorMappingSource = /* @__PURE__ */ ((ConnectorMappingSource2) => {
+  ConnectorMappingSource2["variable"] = "var";
+  ConnectorMappingSource2["value"] = "value";
+  return ConnectorMappingSource2;
+})(ConnectorMappingSource || {});
+var ConnectorMappingDirection = /* @__PURE__ */ ((ConnectorMappingDirection2) => {
+  ConnectorMappingDirection2["engineToConnector"] = "engineToConnector";
+  ConnectorMappingDirection2["connectorToEngine"] = "connectorToEngine";
+  return ConnectorMappingDirection2;
+})(ConnectorMappingDirection || {});
+var ConnectorStateType = /* @__PURE__ */ ((ConnectorStateType2) => {
+  ConnectorStateType2["loading"] = "loading";
+  ConnectorStateType2["loaded"] = "loaded";
+  ConnectorStateType2["running"] = "running";
+  ConnectorStateType2["ready"] = "ready";
+  ConnectorStateType2["error"] = "error";
+  return ConnectorStateType2;
+})(ConnectorStateType || {});
+var ConnectorEventType = /* @__PURE__ */ ((ConnectorEventType2) => {
+  ConnectorEventType2["stateChanged"] = "stateChanged";
+  ConnectorEventType2["authChanged"] = "authChanged";
+  ConnectorEventType2["reloadRequired"] = "reloadRequired";
+  ConnectorEventType2["unloaded"] = "unloaded";
+  return ConnectorEventType2;
+})(ConnectorEventType || {});
+const grafxMediaConnectorRegistration = {
+  url: "grafx-media.json",
+  source: "local"
+  /* local */
+};
+class GrafxTokenAuthCredentials {
+  constructor(token, headers) {
+    this.type = "grafxToken";
+    this.token = token;
+    this.headers = headers;
+  }
+}
+class RefreshedAuthCredendentials {
+  constructor(headers) {
+    this.type = "refreshed";
+    this.headers = headers;
+  }
+}
+var AuthCredentialsTypeEnum = /* @__PURE__ */ ((AuthCredentialsTypeEnum2) => {
+  AuthCredentialsTypeEnum2["grafxToken"] = "grafxToken";
+  AuthCredentialsTypeEnum2["refreshed"] = "refreshed";
+  return AuthCredentialsTypeEnum2;
+})(AuthCredentialsTypeEnum || {});
+var AuthRefreshTypeEnum = /* @__PURE__ */ ((AuthRefreshTypeEnum2) => {
+  AuthRefreshTypeEnum2["grafxToken"] = "grafxToken";
+  AuthRefreshTypeEnum2["any"] = "any";
+  return AuthRefreshTypeEnum2;
+})(AuthRefreshTypeEnum || {});
+var UploadAssetValidationErrorType = /* @__PURE__ */ ((UploadAssetValidationErrorType2) => {
+  UploadAssetValidationErrorType2["minDimension"] = "minDimension";
+  return UploadAssetValidationErrorType2;
+})(UploadAssetValidationErrorType || {});
+class UploadAssetValidationError extends Error {
+  constructor(message, type) {
+    super(message);
+    this.type = type;
+  }
+}
+var ConnectorSupportedAuth = /* @__PURE__ */ ((ConnectorSupportedAuth2) => {
+  ConnectorSupportedAuth2["StaticKey"] = "staticKey";
+  ConnectorSupportedAuth2["OAuth2ClientCredentials"] = "oAuth2ClientCredentials";
+  ConnectorSupportedAuth2["OAuth2AuthorizationCode"] = "oAuth2AuthorizationCode";
+  ConnectorSupportedAuth2["OAuth2ResourceOwnerPassword"] = "oAuth2ResourceOwnerPassword";
+  ConnectorSupportedAuth2["OAuth2JwtBearer"] = "oAuth2JwtBearer";
+  ConnectorSupportedAuth2["None"] = "none";
+  return ConnectorSupportedAuth2;
+})(ConnectorSupportedAuth || {});
+export {
+  AuthCredentialsTypeEnum,
+  AuthRefreshTypeEnum,
+  ConnectorConfigContextType,
+  ConnectorConfigValueType,
+  ConnectorEventType,
+  ConnectorMapping,
+  ConnectorMappingDirection,
+  ConnectorMappingSource,
+  ConnectorRegistrationSource,
+  ConnectorStateType,
+  ConnectorSupportedAuth,
+  ConnectorType,
+  DeprecatedMediaConnectorDownloadType,
+  DeprecatedMediaType,
+  GrafxTokenAuthCredentials,
+  MediaType,
+  RefreshedAuthCredendentials,
+  SortBy,
+  SortOrder,
+  UploadAssetValidationError,
+  UploadAssetValidationErrorType,
+  grafxMediaConnectorRegistration
+};
+//# sourceMappingURL=ConnectorTypes.es.js.map

package/lib/src/types/ConnectorTypes.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectorTypes.es.js","sources":["../../../src/types/ConnectorTypes.ts"],"sourcesContent":["import type {\n    Dictionary as ContextDictionary,\n    ConnectorConfigOptions as GenericConnectorConfigOptions,\n    ConnectorConfigValue as GenericConnectorConfigValue,\n    QueryPage as QueryResult,\n} from '@chili-studio/connector-types';\nimport { Id } from './CommonTypes';\n\nexport type { FilePointer, QueryOptions } from '@chili-studio/connector-types';\n\nexport enum DeprecatedMediaType {\n    file = 0,\n    collection = 1,\n}\n\nexport enum DeprecatedMediaConnectorDownloadType {\n    LowResolutionWeb = 'lowresWeb',\n    HighResolutionWeb = 'highresWeb',\n}\n\nexport enum MediaType {\n    file = 'file',\n    collection = 'collection',\n}\n\nexport enum ConnectorType {\n    media = 'media',\n    fonts = 'fonts',\n    data = 'data',\n    /**\n     * @experimental This is still experimental and might change in future releases.\n     */\n    components = 'components',\n}\n\nexport enum SortBy {\n    name = 'name',\n    path = 'relativePath',\n    id = 'id',\n}\n\nexport enum SortOrder {\n    ascending = 'asc',\n    descending = 'desc',\n}\n\nexport enum ConnectorConfigValueType {\n    text = 'text',\n    boolean = 'boolean',\n    number = 'number',\n}\n\nexport enum ConnectorConfigContextType {\n    query = 'query',\n    upload = 'upload',\n}\n\nexport type ConnectorConfigValue = GenericConnectorConfigValue<ConnectorConfigValueType, ConnectorConfigContextType>;\nexport type ConnectorConfigOptions = GenericConnectorConfigOptions<\n    ConnectorConfigValueType,\n    ConnectorConfigContextType\n>;\n\ninterface ConnectorRegistrationBase {\n    /**\n     * Url to the connector.\n     *\n     * - If source is `url`, this must be a publicly accessible url.\n     *\n     * - If source is `grafx`, this must be the full url to the connector GET endpoint on GraFx Environment API.\n     */\n    url: string;\n\n    /**\n     * Connector source type.\n     */\n    source: ConnectorRegistrationSource;\n}\n\nexport interface ConnectorUrlRegistration extends ConnectorRegistrationBase {\n    source: ConnectorRegistrationSource.url;\n}\n\nexport interface ConnectorGrafxRegistration extends ConnectorRegistrationBase {\n    source: ConnectorRegistrationSource.grafx;\n}\n\nexport interface ConnectorLocalRegistration extends ConnectorRegistrationBase {\n    source: ConnectorRegistrationSource.local;\n}\n\nexport type ConnectorRegistration = ConnectorUrlRegistration | ConnectorGrafxRegistration | ConnectorLocalRegistration;\n\nexport type ConnectorInstance = {\n    id: Id;\n    name: string;\n    iconUrl: string;\n    source: ConnectorRegistration;\n};\n\nexport enum ConnectorRegistrationSource {\n    /**\n     * Connector is hosted on a publicly accessible link.\n     */\n    url = 'url',\n\n    /**\n     * Connector is hosted on GraFx Environment API.\n     */\n    grafx = 'grafx',\n\n    /**\n     * Connector is embedded in the document.\n     * Note: This is a temporary type; only to be used internally.\n     */\n    local = 'local',\n}\n\nexport interface EngineToConnectorMapping {\n    name: string;\n    value: ContextDictionary[keyof ContextDictionary];\n    direction: ConnectorMappingDirection.engineToConnector;\n}\n\nexport interface ConnectorToEngineMapping {\n    name: string;\n    value: string;\n    direction: ConnectorMappingDirection.connectorToEngine;\n}\n\nexport type ConnectorMappingType = EngineToConnectorMapping | ConnectorToEngineMapping;\n\nexport class ConnectorMapping implements EngineToConnectorMapping, ConnectorToEngineMapping {\n    name: string;\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    value: any;\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    direction: any = ConnectorMappingDirection.engineToConnector;\n\n    constructor(\n        contextProperty: string,\n        mapFrom: ConnectorMappingSource.variable,\n        sourceValue: string,\n        direction: ConnectorMappingDirection.connectorToEngine,\n    );\n    constructor(\n        contextProperty: string,\n        mapFrom: ConnectorMappingSource,\n        sourceValue: string | boolean | number,\n        direction?: ConnectorMappingDirection.engineToConnector,\n    );\n    constructor(contextProperty: string, mapFrom: ConnectorMappingSource, sourceValue: string | boolean | number);\n    constructor(\n        contextProperty: string,\n        mapFrom: ConnectorMappingSource,\n        sourceValue: string | boolean | number,\n        direction = ConnectorMappingDirection.engineToConnector,\n    ) {\n        this.name = contextProperty;\n        this.direction = direction;\n\n        if (mapFrom === ConnectorMappingSource.variable) {\n            this.value = `${mapFrom}.${sourceValue}`;\n        } else {\n            this.value = sourceValue;\n        }\n    }\n}\n\nexport type ConnectorState = {\n    id: Id;\n    type: ConnectorStateType;\n};\n\nexport type ConnectorEvent = {\n    id: Id;\n    type: ConnectorEventType;\n};\n\nexport type QueryPage<T> = Omit<QueryResult<T>, 'links'> & {\n    nextPageToken?: string;\n};\n\nexport enum ConnectorMappingSource {\n    variable = 'var',\n    value = 'value',\n}\n\n/**\n * Direction of the Connector Mapping.\n */\nexport enum ConnectorMappingDirection {\n    /**\n     * Indicates the mapping will propagate a value to the connector. This\n     * mapping might cause the linked connector to refresh.\n     */\n    engineToConnector = 'engineToConnector',\n\n    /**\n     * Indicates the mapping will propagate a value from inside the connector\n     * to the engine. AKA \"reverse mapping\".\n     */\n    connectorToEngine = 'connectorToEngine',\n}\n\nexport enum ConnectorStateType {\n    /**\n     * Connector loading process has started.\n     * Any SDK methods that required the connector id, will start working now.\n     */\n    loading = 'loading',\n\n    /**\n     * Connector loading completed.\n     */\n    loaded = 'loaded',\n\n    /**\n     * Connector is running in QuickJS.\n     */\n\n    running = 'running',\n\n    /**\n     * Connector is fully configured and has the correct authentication information.\n     * At this point the connector is ready to make requests.\n     */\n    ready = 'ready',\n\n    /**\n     * Something went wrong, the connector is in error state.\n     * Check the error message for more information.\n     */\n    error = 'error',\n}\n\nexport enum ConnectorEventType {\n    /**\n     * This event will be triggered by the following state changes of the connector\n     * - loading\n     * - loaded\n     * - running\n     * - ready\n     * - error\n     */\n    stateChanged = 'stateChanged',\n\n    /**\n     * Authentication information is changed\n     */\n    authChanged = 'authChanged',\n\n    /**\n     * Connector configuration changed that requires the connector to be reloaded in QuickJS.\n     * This will trigger multiple 'stateChanged' events while it is reloading.\n     * Wait until 'ready'-stateChanged event is received to start using the connector again.\n     */\n    reloadRequired = 'reloadRequired',\n\n    /**\n     * Connector is unregistered and no longer exists inside the editor engine.\n     * Don't use the 'connectorId' after receiving this event.\n     */\n    unloaded = 'unloaded',\n}\n\n/**\n * Hardcoded grafx media connector until we get it from the environment.\n */\nexport const grafxMediaConnectorRegistration: ConnectorLocalRegistration = {\n    url: 'grafx-media.json',\n    source: ConnectorRegistrationSource.local,\n};\n\n/**\n * Grafx token to return to the engine when it expires.\n */\nexport class GrafxTokenAuthCredentials {\n    token: string;\n    type = AuthCredentialsTypeEnum.grafxToken;\n    /**\n     * Optional HTTP headers to send with connector requests (e.g. Authorization).\n     */\n    headers?: Record<string, string>;\n\n    constructor(token: string, headers?: Record<string, string>) {\n        this.token = token;\n        this.headers = headers;\n    }\n}\n\n/**\n * Notification to return to the engine whenever a 3rd party auth (user impersonation)\n * has been renewed by the integration.\n */\nexport class RefreshedAuthCredendentials {\n    type = AuthCredentialsTypeEnum.refreshed;\n    /**\n     * Optional HTTP headers to send with connector requests (e.g. Authorization).\n     */\n    headers?: Record<string, string>;\n\n    constructor(headers?: Record<string, string>) {\n        this.headers = headers;\n    }\n}\n\nexport enum AuthCredentialsTypeEnum {\n    grafxToken = 'grafxToken',\n    refreshed = 'refreshed',\n}\n\nexport type AuthCredentials = GrafxTokenAuthCredentials | RefreshedAuthCredendentials;\n\nexport enum AuthRefreshTypeEnum {\n    grafxToken = 'grafxToken',\n    any = 'any',\n}\n\nexport type GrafxAuthRefreshRequest = {\n    type: AuthRefreshTypeEnum.grafxToken;\n};\n\n/**\n * @param connectorId connector id\n * @param remoteConnectorId remote connector id\n * @param headerValue the value of the X-GRAFX-UNAUTHORIZED header. This\n *      will notify that the dam authentication expired if it went through the\n *      proxy.\n *      Example: \"Static, 1234\", \"OAuthClientCredentials, 5678\"\n *      If the http request did not go through the proxy, headerValue is null.\n */\nexport type AnyAuthRefreshRequest = {\n    type: AuthRefreshTypeEnum.any;\n    connectorId: Id;\n    remoteConnectorId: Id;\n    headerValue: string | null;\n    connectorDefinition: ConnectorDefinition;\n};\n\nexport type AuthRefreshRequest = GrafxAuthRefreshRequest | AnyAuthRefreshRequest;\n\nexport type ConnectorOptions = ContextDictionary;\nexport type MetaData = ContextDictionary;\n\nexport type UploadValidationConfiguration = {\n    minWidthPixels?: number | null;\n    maxWidthPixels?: number | null;\n    minHeightPixels?: number | null;\n    maxHeightPixels?: number | null;\n    mimeTypes?: string[];\n};\n\nexport enum UploadAssetValidationErrorType {\n    minDimension = 'minDimension',\n}\n\nexport class UploadAssetValidationError extends Error {\n    constructor(message: string, public type: UploadAssetValidationErrorType) {\n        super(message);\n    }\n}\n\nexport enum ConnectorSupportedAuth {\n    StaticKey = 'staticKey',\n    OAuth2ClientCredentials = 'oAuth2ClientCredentials',\n    OAuth2AuthorizationCode = 'oAuth2AuthorizationCode',\n    OAuth2ResourceOwnerPassword = 'oAuth2ResourceOwnerPassword',\n    OAuth2JwtBearer = 'oAuth2JwtBearer',\n    None = 'none',\n}\n\ninterface ConnectorDefinition {\n    id: Id;\n    name: string;\n    type: ConnectorType;\n    supportedAuthentication: { browser: ConnectorSupportedAuth[]; server: ConnectorSupportedAuth[] };\n    externalSourceId?: string | null;\n}\n"],"names":["DeprecatedMediaType","DeprecatedMediaConnectorDownloadType","MediaType","ConnectorType","SortBy","SortOrder","ConnectorConfigValueType","ConnectorConfigContextType","ConnectorRegistrationSource","ConnectorMappingSource","ConnectorMappingDirection","ConnectorStateType","ConnectorEventType","AuthCredentialsTypeEnum","AuthRefreshTypeEnum","UploadAssetValidationErrorType","ConnectorSupportedAuth"],"mappings":"AAUO,IAAK,wCAAAA,yBAAL;AACHA,uBAAAA,qBAAA,UAAO,CAAA,IAAP;AACAA,uBAAAA,qBAAA,gBAAa,CAAA,IAAb;AAFQ,SAAAA;AAAA,GAAA,uBAAA,CAAA,CAAA;AAKL,IAAK,yDAAAC,0CAAL;AACHA,wCAAA,kBAAA,IAAmB;AACnBA,wCAAA,mBAAA,IAAoB;AAFZ,SAAAA;AAAA,GAAA,wCAAA,CAAA,CAAA;AAKL,IAAK,8BAAAC,eAAL;AACHA,aAAA,MAAA,IAAO;AACPA,aAAA,YAAA,IAAa;AAFL,SAAAA;AAAA,GAAA,aAAA,CAAA,CAAA;AAKL,IAAK,kCAAAC,mBAAL;AACHA,iBAAA,OAAA,IAAQ;AACRA,iBAAA,OAAA,IAAQ;AACRA,iBAAA,MAAA,IAAO;AAIPA,iBAAA,YAAA,IAAa;AAPL,SAAAA;AAAA,GAAA,iBAAA,CAAA,CAAA;AAUL,IAAK,2BAAAC,YAAL;AACHA,UAAA,MAAA,IAAO;AACPA,UAAA,MAAA,IAAO;AACPA,UAAA,IAAA,IAAK;AAHG,SAAAA;AAAA,GAAA,UAAA,CAAA,CAAA;AAML,IAAK,8BAAAC,eAAL;AACHA,aAAA,WAAA,IAAY;AACZA,aAAA,YAAA,IAAa;AAFL,SAAAA;AAAA,GAAA,aAAA,CAAA,CAAA;AAKL,IAAK,6CAAAC,8BAAL;AACHA,4BAAA,MAAA,IAAO;AACPA,4BAAA,SAAA,IAAU;AACVA,4BAAA,QAAA,IAAS;AAHD,SAAAA;AAAA,GAAA,4BAAA,CAAA,CAAA;AAML,IAAK,+CAAAC,gCAAL;AACHA,8BAAA,OAAA,IAAQ;AACRA,8BAAA,QAAA,IAAS;AAFD,SAAAA;AAAA,GAAA,8BAAA,CAAA,CAAA;AAgDL,IAAK,gDAAAC,iCAAL;AAIHA,+BAAA,KAAA,IAAM;AAKNA,+BAAA,OAAA,IAAQ;AAMRA,+BAAA,OAAA,IAAQ;AAfA,SAAAA;AAAA,GAAA,+BAAA,CAAA,CAAA;AAgCL,MAAM,iBAA+E;AAAA,EAoBxF,YACI,iBACA,SACA,aACA,YAAY,qBACd;AApBF,SAAA,YAAiB;AAqBb,SAAK,OAAO;AACZ,SAAK,YAAY;AAEjB,QAAI,YAAY,OAAiC;AAC7C,WAAK,QAAQ,GAAG,OAAO,IAAI,WAAW;AAAA,IAC1C,OAAO;AACH,WAAK,QAAQ;AAAA,IACjB;AAAA,EACJ;AACJ;AAgBO,IAAK,2CAAAC,4BAAL;AACHA,0BAAA,UAAA,IAAW;AACXA,0BAAA,OAAA,IAAQ;AAFA,SAAAA;AAAA,GAAA,0BAAA,CAAA,CAAA;AAQL,IAAK,8CAAAC,+BAAL;AAKHA,6BAAA,mBAAA,IAAoB;AAMpBA,6BAAA,mBAAA,IAAoB;AAXZ,SAAAA;AAAA,GAAA,6BAAA,CAAA,CAAA;AAcL,IAAK,uCAAAC,wBAAL;AAKHA,sBAAA,SAAA,IAAU;AAKVA,sBAAA,QAAA,IAAS;AAMTA,sBAAA,SAAA,IAAU;AAMVA,sBAAA,OAAA,IAAQ;AAMRA,sBAAA,OAAA,IAAQ;AA5BA,SAAAA;AAAA,GAAA,sBAAA,CAAA,CAAA;AA+BL,IAAK,uCAAAC,wBAAL;AASHA,sBAAA,cAAA,IAAe;AAKfA,sBAAA,aAAA,IAAc;AAOdA,sBAAA,gBAAA,IAAiB;AAMjBA,sBAAA,UAAA,IAAW;AA3BH,SAAAA;AAAA,GAAA,sBAAA,CAAA,CAAA;AAiCL,MAAM,kCAA8D;AAAA,EACvE,KAAK;AAAA,EACL,QAAQ;AAAA;AACZ;AAKO,MAAM,0BAA0B;AAAA,EAQnC,YAAY,OAAe,SAAkC;AAN7D,SAAA,OAAO;AAOH,SAAK,QAAQ;AACb,SAAK,UAAU;AAAA,EACnB;AACJ;AAMO,MAAM,4BAA4B;AAAA,EAOrC,YAAY,SAAkC;AAN9C,SAAA,OAAO;AAOH,SAAK,UAAU;AAAA,EACnB;AACJ;AAEO,IAAK,4CAAAC,6BAAL;AACHA,2BAAA,YAAA,IAAa;AACbA,2BAAA,WAAA,IAAY;AAFJ,SAAAA;AAAA,GAAA,2BAAA,CAAA,CAAA;AAOL,IAAK,wCAAAC,yBAAL;AACHA,uBAAA,YAAA,IAAa;AACbA,uBAAA,KAAA,IAAM;AAFE,SAAAA;AAAA,GAAA,uBAAA,CAAA,CAAA;AAuCL,IAAK,mDAAAC,oCAAL;AACHA,kCAAA,cAAA,IAAe;AADP,SAAAA;AAAA,GAAA,kCAAA,CAAA,CAAA;AAIL,MAAM,mCAAmC,MAAM;AAAA,EAClD,YAAY,SAAwB,MAAsC;AACtE,UAAM,OAAO;AADmB,SAAA,OAAA;AAAA,EAEpC;AACJ;AAEO,IAAK,2CAAAC,4BAAL;AACHA,0BAAA,WAAA,IAAY;AACZA,0BAAA,yBAAA,IAA0B;AAC1BA,0BAAA,yBAAA,IAA0B;AAC1BA,0BAAA,6BAAA,IAA8B;AAC9BA,0BAAA,iBAAA,IAAkB;AAClBA,0BAAA,MAAA,IAAO;AANC,SAAAA;AAAA,GAAA,0BAAA,CAAA,CAAA;"}

package/lib/src/types/DataConnectorTypes.d.ts

@@ -8,4 +8,4 @@ export type BidirectionalNavigation = {
 export type EditorDataPage<Item, N extends OneDirectionalNavigation | BidirectionalNavigation = OneDirectionalNavigation> = {
     data: Item[];
 } & N;
-export type { DataConnectorCapabilities, DataItem, DataModel, DataSourceVariableDataModel, DataPage, BidirectionalDataPage, BidirectionalDataPageItem, PageConfig, PageItemOptions, BidirectionalPageConfig, } from '../../../connector-types/src';
+export type { DataConnectorCapabilities, DataItem, DataModel, DataSourceVariableDataModel, DataPage, BidirectionalDataPage, BidirectionalDataPageItem, PageConfig, PageItemOptions, BidirectionalPageConfig, JsonValue, } from '../../../connector-types/src';

package/lib/src/types/DocumentTypes.cjs.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+var DocumentIssueTypeEnum = /* @__PURE__ */ ((DocumentIssueTypeEnum2) => {
+  DocumentIssueTypeEnum2["overflow"] = "overflow";
+  DocumentIssueTypeEnum2["fontLoading"] = "fontLoading";
+  DocumentIssueTypeEnum2["actionRegister"] = "actionRegister";
+  DocumentIssueTypeEnum2["actionExecution"] = "actionExecution";
+  DocumentIssueTypeEnum2["actionCircular"] = "actionCircular";
+  return DocumentIssueTypeEnum2;
+})(DocumentIssueTypeEnum || {});
+var DocumentType = /* @__PURE__ */ ((DocumentType2) => {
+  DocumentType2["project"] = "project";
+  DocumentType2["template"] = "template";
+  DocumentType2["component"] = "component";
+  return DocumentType2;
+})(DocumentType || {});
+exports.DocumentIssueTypeEnum = DocumentIssueTypeEnum;
+exports.DocumentType = DocumentType;
+//# sourceMappingURL=DocumentTypes.cjs.js.map

package/lib/src/types/DocumentTypes.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentTypes.cjs.js","sources":["../../../src/types/DocumentTypes.ts"],"sourcesContent":["import { ActionEventErrorData } from '../exceptions';\nimport { DocumentAction } from './ActionTypes';\nimport { BasicAnimationsEmphasisType, BasicAnimationsIntroType, BasicAnimationsOutroType } from './AnimationTypes';\nimport { CharacterStyle } from './CharacterStyleTypes';\nimport { DocumentColor } from './ColorStyleTypes';\nimport { Id } from './CommonTypes';\nimport { BlendMode, FrameTypeEnum } from './FrameTypes';\nimport { LayoutIntent, LayoutType } from './LayoutTypes';\nimport { ParagraphStyle } from './ParagraphStyleTypes';\nimport { ShapeProperties } from './ShapeTypes';\nimport { Variable } from './VariableTypes';\n\nexport type DocumentError = { error: Record<string, unknown>; code: number };\n\nexport enum DocumentIssueTypeEnum {\n    overflow = 'overflow',\n    fontLoading = 'fontLoading',\n    actionRegister = 'actionRegister',\n    actionExecution = 'actionExecution',\n    actionCircular = 'actionCircular',\n}\n\nexport type OverflowDocumentIssue = {\n    frameId: Id;\n    type: DocumentIssueTypeEnum.overflow;\n};\n\nexport type FontLoadingDocumentIssue = {\n    fontId: string;\n    name: string;\n    type: DocumentIssueTypeEnum.fontLoading;\n};\n\nexport type ActionExecutionDocumentIssue = {\n    actionId: string;\n    type: DocumentIssueTypeEnum.actionExecution;\n};\n\nexport type ActionRegisterDocumentIssue = {\n    actionId: string;\n    type: DocumentIssueTypeEnum.actionRegister;\n};\n\nexport type ActionCircularDocumentIssue = {\n    eventChain: ActionEventErrorData[];\n    type: DocumentIssueTypeEnum.actionCircular;\n};\n\nexport type DocumentIssue =\n    | OverflowDocumentIssue\n    | FontLoadingDocumentIssue\n    | ActionExecutionDocumentIssue\n    | ActionRegisterDocumentIssue\n    | ActionCircularDocumentIssue;\n\nexport type UndoState = {\n    canUndo: boolean;\n    canRedo: boolean;\n    undoItemName: OperationName;\n    redoItemName: OperationName;\n};\n\nexport type OperationName = { translationKey: number; name: string };\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n *\n * This type should give a clear indication of how the JSON document is structured. This could help you with building a test document yourself.\n */\nexport interface ChiliDocument {\n    selectedLayoutId: string;\n    properties?: TemplateDocumentProperties | ProjectDocumentProperties;\n    pages: DocumentPage[];\n    layouts: (ChildLayout | TopLayout)[];\n    stylekit: DocumentStylekit;\n    variables: Variable[];\n    actions: DocumentAction[];\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface DocumentPage {\n    id: string;\n    number: number;\n    frames: (ImageFrame | TextFrame | ShapeFrame)[];\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface DocumentFrame {\n    id: string;\n    name: string;\n    type: FrameTypeEnum;\n    blendMode: BlendMode;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface ImageFrame extends DocumentFrame {\n    src: ImageFrameUrlSource | ImageFrameConnectorSource | ImageFrameVariableSource;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface ShapeFrame extends DocumentFrame {\n    shapeProperties: ShapeProperties;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface TextFrame extends DocumentFrame {\n    textContent: string;\n    paddingLeft: number;\n    paddingTop: number;\n    paddingRight: number;\n    paddingBottom: number;\n    numberOfColumns: number;\n    columnGap: number;\n    textDirection: string;\n    flowDirection: string;\n    verticalAlign: string;\n    textStroke: boolean;\n    textStrokeWeight: number;\n    textStrokeColor: number;\n    hasClippingPath: boolean;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport enum ImageFrameSourceType {\n    url = 'url',\n    assetProvider = 'assetProvider',\n    variable = 'variable',\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface ImageFrameSource {\n    type: ImageFrameSourceType;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface ImageFrameUrlSource extends ImageFrameSource {\n    url: string;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface ImageFrameConnectorSource extends ImageFrameSource {\n    id: string;\n    assetId: string;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */ export interface ImageFrameVariableSource extends ImageFrameSource {\n    id: string;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface Layout {\n    id: string;\n    name: string;\n    frameProperties: (ChildFrameProperty | TopFrameProperty)[];\n    width?: number;\n    height?: number;\n    childLayouts: string[];\n    type: LayoutType;\n    frameAnimations?: FrameAnimation[];\n    timelineLengthMs?: number;\n    animated?: boolean;\n    intent?: LayoutIntent;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface TopLayout extends Layout {\n    frameAnimations: FrameAnimation[];\n    timelineLengthMs: number;\n    animated: boolean;\n    intent: LayoutIntent;\n    width: number;\n    height: number;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface ChildLayout extends Layout {\n    parentId: Id;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport enum FramePropertiesType {\n    top = 'top',\n    child = 'child',\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface FrameProperty {\n    id: Id;\n    x?: number;\n    y?: number;\n    width?: number;\n    height?: number;\n    rotationDegrees?: number;\n    rotationOriginY?: number;\n    scaleX?: number;\n    scaleY?: number;\n    isVisible?: boolean;\n    type: FramePropertiesType;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport type ChildFrameProperty = FrameProperty;\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface TopFrameProperty extends FrameProperty {\n    x: number;\n    y: number;\n    width: number;\n    height: number;\n    rotationDegrees: number;\n    rotationOriginY: number;\n    scaleX: number;\n    scaleY: number;\n    isVisible: boolean;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface FrameAnimation {\n    id: Id;\n    from: number;\n    to: number;\n    basicAnimations: BasicAnimations;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface BasicAnimations {\n    intro?: BasicAnimationsIntroType;\n    emphasis?: BasicAnimationsEmphasisType;\n    outro?: BasicAnimationsOutroType;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface DocumentStylekit {\n    colors: DocumentColor[];\n    characterStyles: DocumentCharacterStyle[];\n    paragraphStyles: DocumentParagraphStyle[];\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport type DocumentCharacterStyle = CharacterStyle;\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport type DocumentParagraphStyle = ParagraphStyle;\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface DocumentVariable extends Variable {\n    parentId: Id;\n    name: string;\n    label: string;\n    isReadonly: boolean;\n    isRequired: boolean;\n    value: string;\n    defaultValue: string;\n}\n\nexport enum DocumentType {\n    project = 'project',\n    template = 'template',\n    /**\n     * @experimental This document type is experimental and may change or be removed in future releases.\n     */\n    component = 'component',\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface DocumentProperties {\n    type: DocumentType;\n}\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport type TemplateDocumentProperties = DocumentProperties;\n\n/**\n * @deprecated This is no longer kept up to date and will be removed in the future.\n */\nexport interface ProjectDocumentProperties extends DocumentProperties {\n    templateId: string;\n}\n\nexport type DocumentLoadOptions = {\n    keepConnectors: boolean;\n};\n"],"names":["DocumentIssueTypeEnum","DocumentType"],"mappings":";;AAcO,IAAK,0CAAAA,2BAAL;AACHA,yBAAA,UAAA,IAAW;AACXA,yBAAA,aAAA,IAAc;AACdA,yBAAA,gBAAA,IAAiB;AACjBA,yBAAA,iBAAA,IAAkB;AAClBA,yBAAA,gBAAA,IAAiB;AALT,SAAAA;AAAA,GAAA,yBAAA,CAAA,CAAA;AA8RL,IAAK,iCAAAC,kBAAL;AACHA,gBAAA,SAAA,IAAU;AACVA,gBAAA,UAAA,IAAW;AAIXA,gBAAA,WAAA,IAAY;AANJ,SAAAA;AAAA,GAAA,gBAAA,CAAA,CAAA;;;"}

package/lib/src/types/DocumentTypes.es.js

@@ -0,0 +1,19 @@
+var DocumentIssueTypeEnum = /* @__PURE__ */ ((DocumentIssueTypeEnum2) => {
+  DocumentIssueTypeEnum2["overflow"] = "overflow";
+  DocumentIssueTypeEnum2["fontLoading"] = "fontLoading";
+  DocumentIssueTypeEnum2["actionRegister"] = "actionRegister";
+  DocumentIssueTypeEnum2["actionExecution"] = "actionExecution";
+  DocumentIssueTypeEnum2["actionCircular"] = "actionCircular";
+  return DocumentIssueTypeEnum2;
+})(DocumentIssueTypeEnum || {});
+var DocumentType = /* @__PURE__ */ ((DocumentType2) => {
+  DocumentType2["project"] = "project";
+  DocumentType2["template"] = "template";
+  DocumentType2["component"] = "component";
+  return DocumentType2;
+})(DocumentType || {});
+export {
+  DocumentIssueTypeEnum,
+  DocumentType
+};
+//# sourceMappingURL=DocumentTypes.es.js.map