@or-sdk/store 2.1.2-beta.4095.0 → 2.1.2-beta.4097.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/types/Store.d.ts +107 -0
  2. package/dist/types/Store.d.ts.map +1 -1
  3. package/package.json +2 -2
package/dist/types/Store.d.ts CHANGED
@@ -1,32 +1,139 @@
1
1
  import { Base } from '@or-sdk/base';
2
2
  import { StoreConfig, GetParams, UniversalGetParams, UploadCredentials, OptionalParams, CrossEnvOptionalParams, DeprecateLegacyStepsParams, ReleaseParams, PaginationParams, SearchParams, CategoryData, VersionOptions, LegacyStepTemplate, UploadCredentialsData, SandboxUploadCredentialsData } from './types';
3
+ /**
4
+ * @deprecated Use @or-sdk/library instead
5
+ */
3
6
  export declare class Store extends Base {
4
7
  private readonly packageType;
8
+ /**
9
+ * ```typescript
10
+ * import { Store } from '@or-sdk/store';
11
+ * import config from '../config';
12
+ *
13
+ * const storeSdk = new Store({
14
+ * token: 'my-account-token-string',
15
+ * storeApiUrl: config.STORE_API_URL
16
+ * });
17
+ * ```
18
+ */
5
19
  constructor(params: StoreConfig);
20
+ /**
21
+ * List all packages
22
+ */
6
23
  getPackages(params: SearchParams, { type, signal }?: OptionalParams): Promise<unknown>;
24
+ /**
25
+ * List all packages from the sandbox
26
+ */
7
27
  getSandbox(params: SearchParams, { type, signal }?: OptionalParams): Promise<unknown>;
28
+ /**
29
+ * List all categories
30
+ */
8
31
  getCategories(params: PaginationParams, { type, signal }?: OptionalParams): Promise<unknown>;
32
+ /**
33
+ * Upsert given category
34
+ */
9
35
  putCategory(data: CategoryData, { type, signal, customHeaders }?: CrossEnvOptionalParams): Promise<unknown>;
36
+ /**
37
+ * Get category by ID
38
+ */
10
39
  getCategoryById({ id }: Pick<GetParams, 'id'>, { type, signal }?: OptionalParams): Promise<unknown>;
40
+ /**
41
+ * Get credentials for uploading the package
42
+ * ```typescript
43
+ * const result = await storeApi.getUploadCredentials({ id: 'id', version: 'version' });
44
+ * ```
45
+ */
11
46
  getUploadCredentials(data: GetParams & UploadCredentialsData, { type, signal, customHeaders }?: CrossEnvOptionalParams): Promise<UploadCredentials>;
47
+ /**
48
+ * Get credentials for uploading the package to the sandbox (playground)
49
+ */
12
50
  getUploadCredentialsSandbox(data: GetParams & SandboxUploadCredentialsData, { type, signal }?: OptionalParams): Promise<unknown>;
51
+ /**
52
+ * List all versions of given package
53
+ */
13
54
  getVersions({ id, isSandbox, includeDeprecated, includeReleaseNotes, includeMember }: Omit<UniversalGetParams, 'version'> & VersionOptions, { type, signal }?: OptionalParams): Promise<unknown>;
55
+ /**
56
+ * Delete given package version from sandbox (playground)
57
+ */
14
58
  deletePackageVersionFromSandbox({ id, version }: GetParams, { type, signal }?: OptionalParams): Promise<unknown>;
59
+ /**
60
+ * Get the latest version of the package meta by ID
61
+ */
15
62
  getPackageMetaLatestVersionById({ id }: Pick<GetParams, 'id'>, { type, signal }?: OptionalParams): Promise<unknown>;
63
+ /**
64
+ * Get download package archive url
65
+ * ```typescript
66
+ * const result = await storeApi.getMetaByVersion({ id: 'id', version: 'version', isSandbox: false });
67
+ * ```
68
+ */
16
69
  getMetaByVersion({ id, version, isSandbox }: UniversalGetParams, { signal, customHeaders, type }?: CrossEnvOptionalParams): Promise<unknown>;
70
+ /**
71
+ * List favorites
72
+ */
17
73
  getFavorites(params: Omit<SearchParams, 'scope'>, { type, signal }?: OptionalParams): Promise<unknown>;
74
+ /**
75
+ * Submit legacy Step Template to Store API
76
+ */
18
77
  submitLegacyStepJson(legacyStepTemplate: LegacyStepTemplate, { signal }?: Pick<OptionalParams, 'signal'>): Promise<unknown>;
78
+ /**
79
+ * Get legacy Step Template from Store API
80
+ */
19
81
  getLegacyStepJson({ id, version }: GetParams, { signal }?: Pick<OptionalParams, 'signal'>): Promise<unknown>;
82
+ /**
83
+ * Sync legacy Step Templates from Sandbox Account
84
+ */
20
85
  syncLegacyStepFromLibrary({ id }: Pick<GetParams, 'id'>, { signal }?: Pick<OptionalParams, 'signal'>): Promise<unknown>;
86
+ /**
87
+ * Set release status
88
+ */
21
89
  setReleaseStatus(data: GetParams & ReleaseParams, { type, signal }?: OptionalParams): Promise<unknown>;
90
+ /**
91
+ * Set release status to BETA
92
+ */
22
93
  setReleaseStatusToBeta(data: GetParams & ReleaseParams, { type, signal }?: OptionalParams): Promise<unknown>;
94
+ /**
95
+ * Set release status to RELEASED
96
+ */
23
97
  setReleaseStatusToReleased(data: GetParams & ReleaseParams, { type, signal }?: OptionalParams): Promise<unknown>;
98
+ /**
99
+ * Set release status to DEPRECATED
100
+ */
24
101
  setReleaseStatusToDeprecated(data: GetParams & ReleaseParams, { type, signal }?: OptionalParams): Promise<unknown>;
102
+ /**
103
+ * Deprecate legacy Step Template
104
+ */
25
105
  deprecateLegacyStep(data: GetParams & ReleaseParams, { signal }?: Pick<OptionalParams, 'signal'>): Promise<unknown>;
106
+ /**
107
+ * Deprecate multiple legacy Step Templates
108
+ */
26
109
  deprecateLegacySteps(data: DeprecateLegacyStepsParams, { signal }?: Pick<OptionalParams, 'signal'>): Promise<unknown>;
110
+ /**
111
+ * Get download package archive url
112
+ * ```typescript
113
+ * const result = await storeApi.getDownloadArchiveCredentials({ id: 'id', version: 'version' });
114
+ * ```
115
+ */
27
116
  getDownloadArchiveCredentials({ id, version }: GetParams, { signal, customHeaders }?: CrossEnvOptionalParams): Promise<string>;
117
+ /**
118
+ * Sync inputs from global library to specific env
119
+ * ```typescript
120
+ * const result = await storeApi.syncInputFromLibrary({ id: 'id', version: 'version' });
121
+ * ```
122
+ */
28
123
  syncInputFromLibrary({ id, version }: GetParams, { signal, customHeaders }?: CrossEnvOptionalParams): Promise<unknown>;
124
+ /**
125
+ * Get new packages
126
+ * ```typescript
127
+ * const result = await storeApi.getNewPackages({size}, {customHeaders: {Auth: 'token'}});)
128
+ * ```
129
+ */
29
130
  getNewPackages(params: GetParams, { signal, customHeaders }?: CrossEnvOptionalParams): Promise<unknown>;
131
+ /**
132
+ * Get popular packages
133
+ * ```typescript
134
+ * const result = await storeApi.getNewPackages({size}, {customHeaders: {Auth: 'token'}});)
135
+ * ```
136
+ */
30
137
  getPopularPackages(params: GetParams, { signal, customHeaders }?: CrossEnvOptionalParams): Promise<unknown>;
31
138
  }
32
139
  //# sourceMappingURL=Store.d.ts.map
package/dist/types/Store.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Store.d.ts","sourceRoot":"","sources":["../../src/Store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAQpC,OAAO,EACL,WAAW,EACX,SAAS,EACT,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,sBAAsB,EACtB,0BAA0B,EAC1B,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,4BAA4B,EAE7B,MAAM,SAAS,CAAC;AAKjB,qBAAa,KAAM,SAAQ,IAAI;IAC7B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;gBAa9B,MAAM,EAAE,WAAW;IAmBzB,WAAW,CACf,MAAM,EAAE,YAAY,EACpB,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAcjC,UAAU,CACd,MAAM,EAAE,YAAY,EACpB,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAcjC,aAAa,CACjB,MAAM,EAAE,gBAAgB,EACxB,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAcjC,WAAW,CACf,IAAI,EAAE,YAAY,EAClB,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,GAAE,sBAA2B;IAgBxD,eAAe,CACnB,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAC7B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAgB1B,oBAAoB,CAC/B,IAAI,EAAE,SAAS,GAAG,qBAAqB,EACvC,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,GAAE,sBAA2B,GAC3D,OAAO,CAAC,iBAAiB,CAAC;IAgBvB,2BAA2B,CAC/B,IAAI,EAAE,SAAS,GAAG,4BAA4B,EAC9C,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAgBjC,WAAW,CACf,EAAE,EAAE,EAAE,SAAS,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,aAAa,EAAE,EACxE,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,GAAG,cAAc,EACpD,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAqBjC,+BAA+B,CACnC,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,SAAS,EAC1B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAcjC,+BAA+B,CACnC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAC7B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAgBjC,gBAAgB,CACpB,EAAE,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,kBAAkB,EAC9C,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,GAAE,sBAA2B;IAgBxD,YAAY,CAChB,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,EACnC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAcjC,oBAAoB,CACxB,kBAAkB,EAAE,kBAAkB,EACtC,EAAE,MAAM,EAAE,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM;IAsB3C,iBAAiB,CACrB,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,SAAS,EAC1B,EAAE,MAAM,EAAE,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM;IAa3C,yBAAyB,CAC7B,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAC7B,EAAE,MAAM,EAAE,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM;IAc3C,gBAAgB,CACpB,IAAI,EAAE,SAAS,GAAG,aAAa,EAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAyBjC,sBAAsB,CAC1B,IAAI,EAAE,SAAS,GAAG,aAAa,EAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAgBjC,0BAA0B,CAC9B,IAAI,EAAE,SAAS,GAAG,aAAa,EAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAgBjC,4BAA4B,CAChC,IAAI,EAAE,SAAS,GAAG,aAAa,EAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAgBjC,mBAAmB,CACvB,IAAI,EAAE,SAAS,GAAG,aAAa,EAC/B,EAAE,MAAM,EAAE,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM;IAa3C,oBAAoB,CACxB,IAAI,EAAE,0BAA0B,EAChC,EAAE,MAAM,EAAE,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM;IAgBpC,6BAA6B,CACxC,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,SAAS,EAC1B,EAAE,MAAM,EAAE,aAAa,EAAE,GAAE,sBAA2B,GACrD,OAAO,CAAC,MAAM,CAAC;IAeZ,oBAAoB,CACxB,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,SAAS,EAC1B,EAAE,MAAM,EAAE,aAAa,EAAE,GAAE,sBAA2B;IAgBlD,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,GAAE,sBAA2B;IAgBxF,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,GAAE,sBAA2B;CASnG"}
1
+ {"version":3,"file":"Store.d.ts","sourceRoot":"","sources":["../../src/Store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAQpC,OAAO,EACL,WAAW,EACX,SAAS,EACT,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,sBAAsB,EACtB,0BAA0B,EAC1B,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,4BAA4B,EAE7B,MAAM,SAAS,CAAC;AAEjB;;EAEE;AACF,qBAAa,KAAM,SAAQ,IAAI;IAC7B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAE1C;;;;;;;;;;OAUG;gBACS,MAAM,EAAE,WAAW;IAgB/B;;OAEG;IACG,WAAW,CACf,MAAM,EAAE,YAAY,EACpB,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAWvC;;OAEG;IACG,UAAU,CACd,MAAM,EAAE,YAAY,EACpB,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAWvC;;OAEG;IACG,aAAa,CACjB,MAAM,EAAE,gBAAgB,EACxB,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAWvC;;OAEG;IACG,WAAW,CACf,IAAI,EAAE,YAAY,EAClB,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,GAAE,sBAA2B;IAa9D;;OAEG;IACG,eAAe,CACnB,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAC7B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAUvC;;;;;OAKG;IACU,oBAAoB,CAC/B,IAAI,EAAE,SAAS,GAAG,qBAAqB,EACvC,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,GAAE,sBAA2B,GAC3D,OAAO,CAAC,iBAAiB,CAAC;IAa7B;;OAEG;IACG,2BAA2B,CAC/B,IAAI,EAAE,SAAS,GAAG,4BAA4B,EAC9C,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAavC;;OAEG;IACG,WAAW,CACf,EAAE,EAAE,EAAE,SAAS,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,aAAa,EAAE,EACxE,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,GAAG,cAAc,EACpD,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAkBvC;;OAEG;IACG,+BAA+B,CACnC,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,SAAS,EAC1B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAWvC;;OAEG;IACG,+BAA+B,CACnC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAC7B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAUvC;;;;;OAKG;IACG,gBAAgB,CACpB,EAAE,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,kBAAkB,EAC9C,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,GAAE,sBAA2B;IAa9D;;OAEG;IACG,YAAY,CAChB,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,EACnC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAWvC;;OAEG;IACG,oBAAoB,CACxB,kBAAkB,EAAE,kBAAkB,EACtC,EAAE,MAAM,EAAE,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM;IAmBjD;;OAEG;IACG,iBAAiB,CACrB,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,SAAS,EAC1B,EAAE,MAAM,EAAE,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM;IAUjD;;OAEG;IACG,yBAAyB,CAC7B,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAC7B,EAAE,MAAM,EAAE,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM;IAWjD;;OAEG;IACG,gBAAgB,CACpB,IAAI,EAAE,SAAS,GAAG,aAAa,EAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAsBvC;;OAEG;IACG,sBAAsB,CAC1B,IAAI,EAAE,SAAS,GAAG,aAAa,EAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAavC;;OAEG;IACG,0BAA0B,CAC9B,IAAI,EAAE,SAAS,GAAG,aAAa,EAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAavC;;OAEG;IACG,4BAA4B,CAChC,IAAI,EAAE,SAAS,GAAG,aAAa,EAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,GAAE,cAAmB;IAavC;;OAEG;IACG,mBAAmB,CACvB,IAAI,EAAE,SAAS,GAAG,aAAa,EAC/B,EAAE,MAAM,EAAE,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM;IAUjD;;OAEG;IACG,oBAAoB,CACxB,IAAI,EAAE,0BAA0B,EAChC,EAAE,MAAM,EAAE,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM;IAUjD;;;;;OAKG;IACU,6BAA6B,CACxC,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,SAAS,EAC1B,EAAE,MAAM,EAAE,aAAa,EAAE,GAAE,sBAA2B,GACrD,OAAO,CAAC,MAAM,CAAC;IASlB;;;;;OAKG;IACG,oBAAoB,CACxB,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,SAAS,EAC1B,EAAE,MAAM,EAAE,aAAa,EAAE,GAAE,sBAA2B;IAUxD;;;;;OAKG;IACG,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,GAAE,sBAA2B;IAU9F;;;;;SAKK;IACC,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,GAAE,sBAA2B;CASnG"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/store",
3
- "version": "2.1.2-beta.4095.0",
3
+ "version": "2.1.2-beta.4097.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -18,7 +18,7 @@
18
18
  "dev": "pnpm build:watch:esm"
19
19
  },
20
20
  "dependencies": {
21
- "@or-sdk/base": "^0.44.1-beta.4095.0"
21
+ "@or-sdk/base": "^0.44.1-beta.4097.0"
22
22
  },
23
23
  "devDependencies": {
24
24
  "concurrently": "9.0.1",