@uniformdev/canvas 19.65.1-alpha.4 → 19.67.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.mts +3 -132
  2. package/dist/index.d.ts +3 -132
  3. package/package.json +4 -3
package/dist/index.d.mts CHANGED
@@ -1,5 +1,6 @@
1
1
  import { ApiClient, ExceptProject, ClientOptions, ApiClientError } from '@uniformdev/context/api';
2
2
  export { ApiClientError } from '@uniformdev/context/api';
3
+ import { AssetGetResponseSingle } from '@uniformdev/assets';
3
4
  import Pusher from 'pusher-js';
4
5
  import { Options as Options$1 } from 'p-retry';
5
6
  import { Options } from 'p-throttle';
@@ -12758,6 +12759,7 @@ type CanvasDefinitions = {
12758
12759
  contentTypes?: Array<ContentType>;
12759
12760
  entries?: Array<Entry>;
12760
12761
  prompts?: Array<Prompt>;
12762
+ assets?: Array<AssetGetResponseSingle>;
12761
12763
  };
12762
12764
  /** Defines shared parameters for requests getting a single composition */
12763
12765
  type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId'>;
@@ -12865,138 +12867,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
12865
12867
  diagnostics?: boolean;
12866
12868
  } | {
12867
12869
  resolveData?: false;
12868
- })): Promise<{
12869
- compositions: {
12870
- state: number;
12871
- uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | "Unknown" | undefined;
12872
- projectId: string;
12873
- created: string;
12874
- modified: string;
12875
- creator?: string | undefined;
12876
- author?: string | undefined;
12877
- categoryId?: string | undefined;
12878
- description?: string | undefined;
12879
- previewImageUrl?: string | undefined;
12880
- pattern: boolean;
12881
- composition: {
12882
- type: string;
12883
- parameters?: {
12884
- [key: string]: {
12885
- value: unknown;
12886
- type: string;
12887
- connectedData?: {
12888
- pointer: string;
12889
- syntax: "jptr";
12890
- } | undefined;
12891
- };
12892
- } | undefined;
12893
- variant?: string | undefined;
12894
- projectMapNodes?: {
12895
- id: string;
12896
- path: string;
12897
- projectMapId: string;
12898
- }[] | undefined;
12899
- slots?: {
12900
- [key: string]: {
12901
- type: string;
12902
- parameters?: {
12903
- [key: string]: {
12904
- value: unknown;
12905
- type: string;
12906
- connectedData?: {
12907
- pointer: string;
12908
- syntax: "jptr";
12909
- } | undefined;
12910
- };
12911
- } | undefined;
12912
- variant?: string | undefined;
12913
- slots?: {
12914
- [key: string]: any[];
12915
- } | undefined;
12916
- _id?: string | undefined;
12917
- _pattern?: string | undefined;
12918
- _dataResources?: {
12919
- [key: string]: {
12920
- type: string;
12921
- isPatternParameter?: boolean | undefined;
12922
- ignorePatternParameterDefault?: boolean | undefined;
12923
- variables?: {
12924
- [key: string]: string;
12925
- } | undefined;
12926
- };
12927
- } | undefined;
12928
- _patternDataResources?: {
12929
- [key: string]: {
12930
- type: string;
12931
- isPatternParameter?: boolean | undefined;
12932
- ignorePatternParameterDefault?: boolean | undefined;
12933
- variables?: {
12934
- [key: string]: string;
12935
- } | undefined;
12936
- };
12937
- } | undefined;
12938
- _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
12939
- _overrides?: {
12940
- [key: string]: {
12941
- parameters?: {
12942
- [key: string]: {
12943
- value: unknown;
12944
- type: string;
12945
- connectedData?: {
12946
- pointer: string;
12947
- syntax: "jptr";
12948
- } | undefined;
12949
- };
12950
- } | undefined;
12951
- variant?: string | undefined;
12952
- };
12953
- } | undefined;
12954
- _overridability?: {
12955
- parameters?: {
12956
- [key: string]: "no" | "yes";
12957
- } | undefined;
12958
- variants?: boolean | undefined;
12959
- } | undefined;
12960
- }[];
12961
- } | undefined;
12962
- _id: string;
12963
- _slug?: string | null | undefined;
12964
- _name: string;
12965
- _dataResources?: {
12966
- [key: string]: {
12967
- type: string;
12968
- isPatternParameter?: boolean | undefined;
12969
- ignorePatternParameterDefault?: boolean | undefined;
12970
- variables?: {
12971
- [key: string]: string;
12972
- } | undefined;
12973
- };
12974
- } | undefined;
12975
- _overrides?: {
12976
- [key: string]: {
12977
- parameters?: {
12978
- [key: string]: {
12979
- value: unknown;
12980
- type: string;
12981
- connectedData?: {
12982
- pointer: string;
12983
- syntax: "jptr";
12984
- } | undefined;
12985
- };
12986
- } | undefined;
12987
- variant?: string | undefined;
12988
- };
12989
- } | undefined;
12990
- _overridability?: {
12991
- parameters?: {
12992
- [key: string]: "no" | "yes";
12993
- } | undefined;
12994
- variants?: boolean | undefined;
12995
- } | undefined;
12996
- };
12997
- }[];
12998
- totalCount?: number | undefined;
12999
- }>;
12870
+ })): Promise<CompositionGetListResponse | CompositionResolvedListResponse>;
13000
12871
  /** Fetches one composition by its project map node path */
13001
12872
  getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
13002
12873
  getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
package/dist/index.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import { ApiClient, ExceptProject, ClientOptions, ApiClientError } from '@uniformdev/context/api';
2
2
  export { ApiClientError } from '@uniformdev/context/api';
3
+ import { AssetGetResponseSingle } from '@uniformdev/assets';
3
4
  import Pusher from 'pusher-js';
4
5
  import { Options as Options$1 } from 'p-retry';
5
6
  import { Options } from 'p-throttle';
@@ -12758,6 +12759,7 @@ type CanvasDefinitions = {
12758
12759
  contentTypes?: Array<ContentType>;
12759
12760
  entries?: Array<Entry>;
12760
12761
  prompts?: Array<Prompt>;
12762
+ assets?: Array<AssetGetResponseSingle>;
12761
12763
  };
12762
12764
  /** Defines shared parameters for requests getting a single composition */
12763
12765
  type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId'>;
@@ -12865,138 +12867,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
12865
12867
  diagnostics?: boolean;
12866
12868
  } | {
12867
12869
  resolveData?: false;
12868
- })): Promise<{
12869
- compositions: {
12870
- state: number;
12871
- uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | "Unknown" | undefined;
12872
- projectId: string;
12873
- created: string;
12874
- modified: string;
12875
- creator?: string | undefined;
12876
- author?: string | undefined;
12877
- categoryId?: string | undefined;
12878
- description?: string | undefined;
12879
- previewImageUrl?: string | undefined;
12880
- pattern: boolean;
12881
- composition: {
12882
- type: string;
12883
- parameters?: {
12884
- [key: string]: {
12885
- value: unknown;
12886
- type: string;
12887
- connectedData?: {
12888
- pointer: string;
12889
- syntax: "jptr";
12890
- } | undefined;
12891
- };
12892
- } | undefined;
12893
- variant?: string | undefined;
12894
- projectMapNodes?: {
12895
- id: string;
12896
- path: string;
12897
- projectMapId: string;
12898
- }[] | undefined;
12899
- slots?: {
12900
- [key: string]: {
12901
- type: string;
12902
- parameters?: {
12903
- [key: string]: {
12904
- value: unknown;
12905
- type: string;
12906
- connectedData?: {
12907
- pointer: string;
12908
- syntax: "jptr";
12909
- } | undefined;
12910
- };
12911
- } | undefined;
12912
- variant?: string | undefined;
12913
- slots?: {
12914
- [key: string]: any[];
12915
- } | undefined;
12916
- _id?: string | undefined;
12917
- _pattern?: string | undefined;
12918
- _dataResources?: {
12919
- [key: string]: {
12920
- type: string;
12921
- isPatternParameter?: boolean | undefined;
12922
- ignorePatternParameterDefault?: boolean | undefined;
12923
- variables?: {
12924
- [key: string]: string;
12925
- } | undefined;
12926
- };
12927
- } | undefined;
12928
- _patternDataResources?: {
12929
- [key: string]: {
12930
- type: string;
12931
- isPatternParameter?: boolean | undefined;
12932
- ignorePatternParameterDefault?: boolean | undefined;
12933
- variables?: {
12934
- [key: string]: string;
12935
- } | undefined;
12936
- };
12937
- } | undefined;
12938
- _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
12939
- _overrides?: {
12940
- [key: string]: {
12941
- parameters?: {
12942
- [key: string]: {
12943
- value: unknown;
12944
- type: string;
12945
- connectedData?: {
12946
- pointer: string;
12947
- syntax: "jptr";
12948
- } | undefined;
12949
- };
12950
- } | undefined;
12951
- variant?: string | undefined;
12952
- };
12953
- } | undefined;
12954
- _overridability?: {
12955
- parameters?: {
12956
- [key: string]: "no" | "yes";
12957
- } | undefined;
12958
- variants?: boolean | undefined;
12959
- } | undefined;
12960
- }[];
12961
- } | undefined;
12962
- _id: string;
12963
- _slug?: string | null | undefined;
12964
- _name: string;
12965
- _dataResources?: {
12966
- [key: string]: {
12967
- type: string;
12968
- isPatternParameter?: boolean | undefined;
12969
- ignorePatternParameterDefault?: boolean | undefined;
12970
- variables?: {
12971
- [key: string]: string;
12972
- } | undefined;
12973
- };
12974
- } | undefined;
12975
- _overrides?: {
12976
- [key: string]: {
12977
- parameters?: {
12978
- [key: string]: {
12979
- value: unknown;
12980
- type: string;
12981
- connectedData?: {
12982
- pointer: string;
12983
- syntax: "jptr";
12984
- } | undefined;
12985
- };
12986
- } | undefined;
12987
- variant?: string | undefined;
12988
- };
12989
- } | undefined;
12990
- _overridability?: {
12991
- parameters?: {
12992
- [key: string]: "no" | "yes";
12993
- } | undefined;
12994
- variants?: boolean | undefined;
12995
- } | undefined;
12996
- };
12997
- }[];
12998
- totalCount?: number | undefined;
12999
- }>;
12870
+ })): Promise<CompositionGetListResponse | CompositionResolvedListResponse>;
13000
12871
  /** Fetches one composition by its project map node path */
13001
12872
  getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
13002
12873
  getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/canvas",
3
- "version": "19.65.1-alpha.4+d9220a0f9",
3
+ "version": "19.67.0",
4
4
  "description": "Common functionality and types for Uniform Canvas",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -38,7 +38,8 @@
38
38
  "pusher-js": "8.2.0"
39
39
  },
40
40
  "dependencies": {
41
- "@uniformdev/context": "19.65.1-alpha.4+d9220a0f9",
41
+ "@uniformdev/assets": "19.67.0",
42
+ "@uniformdev/context": "19.67.0",
42
43
  "immer": "9.0.21"
43
44
  },
44
45
  "files": [
@@ -47,5 +48,5 @@
47
48
  "publishConfig": {
48
49
  "access": "public"
49
50
  },
50
- "gitHead": "d9220a0f9c51bae1ae6b97d356ae510ffc484394"
51
+ "gitHead": "9cd9a40e3d0743f52457ebab0dfafc048014c916"
51
52
  }