@kontent-ai/core-sdk 12.0.0-preview.13 → 12.0.0-preview.15
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.
- package/dist/devkit/environment.utils.d.ts +2 -0
- package/dist/devkit/environment.utils.js +12 -0
- package/dist/devkit/environment.utils.js.map +1 -0
- package/dist/devkit_api.d.ts +1 -0
- package/dist/devkit_api.js +1 -0
- package/dist/devkit_api.js.map +1 -1
- package/dist/models/utility.models.d.ts +0 -12
- package/dist/public_api.d.ts +5 -2
- package/dist/public_api.js +4 -0
- package/dist/public_api.js.map +1 -1
- package/dist/sdk/sdk-models.d.ts +4 -0
- package/dist/sdk/sdk-models.js +3 -1
- package/dist/sdk/sdk-models.js.map +1 -1
- package/dist/sdk/sdk-query.d.ts +1 -1
- package/dist/sdk/sdk-query.js +1 -0
- package/dist/sdk/sdk-query.js.map +1 -1
- package/dist/sdk/sdk-utils.d.ts +2 -0
- package/dist/sdk/sdk-utils.js +4 -0
- package/dist/sdk/sdk-utils.js.map +1 -0
- package/dist/sdk-info.js +1 -1
- package/dist/utils/type.utils.d.ts +2 -0
- package/dist/utils/type.utils.js +5 -0
- package/dist/utils/type.utils.js.map +1 -0
- package/dist/utils/url.utils.d.ts +5 -0
- package/dist/utils/url.utils.js +10 -0
- package/dist/utils/url.utils.js.map +1 -0
- package/lib/devkit/environment.utils.ts +15 -0
- package/lib/devkit_api.ts +2 -0
- package/lib/models/utility.models.ts +0 -12
- package/lib/public_api.ts +15 -10
- package/lib/sdk/sdk-models.ts +6 -0
- package/lib/sdk/sdk-query.ts +2 -1
- package/lib/sdk/sdk-utils.ts +5 -0
- package/lib/utils/type.utils.ts +5 -0
- package/lib/utils/url.utils.ts +19 -0
- package/package.json +1 -1
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import chalk from "chalk";
|
|
2
|
+
export function getEnvironmentRequiredValue(variableName) {
|
|
3
|
+
const value = getEnvironmentOptionalValue(variableName);
|
|
4
|
+
if (!value) {
|
|
5
|
+
throw new Error(`Missing environment variable '${chalk.red(variableName)}'`);
|
|
6
|
+
}
|
|
7
|
+
return value;
|
|
8
|
+
}
|
|
9
|
+
export function getEnvironmentOptionalValue(variableName) {
|
|
10
|
+
return process.env[variableName];
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=environment.utils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"environment.utils.js","sourceRoot":"","sources":["../../lib/devkit/environment.utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,UAAU,2BAA2B,CAAC,YAAoB;IAC/D,MAAM,KAAK,GAAG,2BAA2B,CAAC,YAAY,CAAC,CAAC;IAExD,IAAI,CAAC,KAAK,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAC9E,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,YAAoB;IAC/D,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAClC,CAAC"}
|
package/dist/devkit_api.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
1
|
/** biome-ignore-all lint/performance/noBarrelFile: One barrel for exported API is fine */
|
|
2
|
+
export { getEnvironmentOptionalValue, getEnvironmentRequiredValue } from "./devkit/environment.utils.js";
|
|
2
3
|
export { deleteFolderRecursive } from "./devkit/script.utils.js";
|
|
3
4
|
export { replaceSdkVersionPlaceholder } from "./utils/sdk-version.utils.js";
|
package/dist/devkit_api.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
/** biome-ignore-all lint/performance/noBarrelFile: One barrel for exported API is fine */
|
|
2
|
+
export { getEnvironmentOptionalValue, getEnvironmentRequiredValue } from "./devkit/environment.utils.js";
|
|
2
3
|
export { deleteFolderRecursive } from "./devkit/script.utils.js";
|
|
3
4
|
export { replaceSdkVersionPlaceholder } from "./utils/sdk-version.utils.js";
|
|
4
5
|
//# sourceMappingURL=devkit_api.js.map
|
package/dist/devkit_api.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"devkit_api.js","sourceRoot":"","sources":["../lib/devkit_api.ts"],"names":[],"mappings":"AAAA,0FAA0F;
|
|
1
|
+
{"version":3,"file":"devkit_api.js","sourceRoot":"","sources":["../lib/devkit_api.ts"],"names":[],"mappings":"AAAA,0FAA0F;AAE1F,OAAO,EAAE,2BAA2B,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACzG,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC"}
|
|
@@ -1,15 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Improves the type readability by flattening the type.
|
|
3
|
-
*/
|
|
4
|
-
export type Prettify<T> = {
|
|
5
|
-
[K in keyof T]: T[K];
|
|
6
|
-
} & {};
|
|
7
|
-
/**
|
|
8
|
-
* Override selected properties of a type. Uses Omit to remove the properties and then adds the new properties.
|
|
9
|
-
*/
|
|
10
|
-
export type Override<Type, NewType extends {
|
|
11
|
-
[key in keyof Type]?: NewType[key];
|
|
12
|
-
}> = Omit<Type, keyof NewType> & NewType;
|
|
13
1
|
/**
|
|
14
2
|
* Represents an empty object type.
|
|
15
3
|
*/
|
package/dist/public_api.d.ts
CHANGED
|
@@ -5,11 +5,14 @@ export { getDefaultHttpService } from "./http/http.service.js";
|
|
|
5
5
|
export type { CommonHeaderNames, ContinuationHeaderName, ErrorResponseData, Header, HttpMethod, RetryStrategyOptions, SDKInfo, ValidationError, } from "./models/core.models.js";
|
|
6
6
|
export { type ErrorReason, type ErrorReasonData, KontentSdkError } from "./models/error.models.js";
|
|
7
7
|
export type { JsonArray, JsonObject, JsonValue } from "./models/json.models.js";
|
|
8
|
-
export type { EmptyObject
|
|
8
|
+
export type { EmptyObject } from "./models/utility.models.js";
|
|
9
9
|
export { createPagingQuery } from "./sdk/paging-sdk-query.js";
|
|
10
|
-
export type
|
|
10
|
+
export { kontentUuidSchema, nilUuid, type PagingQuery, type PagingQueryResult, type Query, type QueryResponse, type QueryResponseMeta, type QueryResult, type SdkConfig, type SuccessfulHttpResponse, } from "./sdk/sdk-models.js";
|
|
11
11
|
export { createQuery, extractContinuationToken } from "./sdk/sdk-query.js";
|
|
12
|
+
export { isPagingQuery } from "./sdk/sdk-utils.js";
|
|
12
13
|
export { isKontent404Error, isKontentSdkError } from "./utils/error.utils.js";
|
|
13
14
|
export { getSdkIdHeader } from "./utils/header.utils.js";
|
|
14
15
|
export { toRequiredRetryStrategyOptions } from "./utils/retry.utils.js";
|
|
15
16
|
export { tryCatch, tryCatchAsync } from "./utils/try.utils.js";
|
|
17
|
+
export { getCodenameSchema } from "./utils/type.utils.js";
|
|
18
|
+
export { getEndpointUrl } from "./utils/url.utils.js";
|
package/dist/public_api.js
CHANGED
|
@@ -3,9 +3,13 @@ export { getDefaultHttpAdapter } from "./http/http.adapter.js";
|
|
|
3
3
|
export { getDefaultHttpService } from "./http/http.service.js";
|
|
4
4
|
export { KontentSdkError } from "./models/error.models.js";
|
|
5
5
|
export { createPagingQuery } from "./sdk/paging-sdk-query.js";
|
|
6
|
+
export { kontentUuidSchema, nilUuid, } from "./sdk/sdk-models.js";
|
|
6
7
|
export { createQuery, extractContinuationToken } from "./sdk/sdk-query.js";
|
|
8
|
+
export { isPagingQuery } from "./sdk/sdk-utils.js";
|
|
7
9
|
export { isKontent404Error, isKontentSdkError } from "./utils/error.utils.js";
|
|
8
10
|
export { getSdkIdHeader } from "./utils/header.utils.js";
|
|
9
11
|
export { toRequiredRetryStrategyOptions } from "./utils/retry.utils.js";
|
|
10
12
|
export { tryCatch, tryCatchAsync } from "./utils/try.utils.js";
|
|
13
|
+
export { getCodenameSchema } from "./utils/type.utils.js";
|
|
14
|
+
export { getEndpointUrl } from "./utils/url.utils.js";
|
|
11
15
|
//# sourceMappingURL=public_api.js.map
|
package/dist/public_api.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"public_api.js","sourceRoot":"","sources":["../lib/public_api.ts"],"names":[],"mappings":"AAAA,0FAA0F;AAC1F,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAe/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAW/D,OAAO,EAA0C,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAGnG,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;
|
|
1
|
+
{"version":3,"file":"public_api.js","sourceRoot":"","sources":["../lib/public_api.ts"],"names":[],"mappings":"AAAA,0FAA0F;AAC1F,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAe/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAW/D,OAAO,EAA0C,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAGnG,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EACN,iBAAiB,EACjB,OAAO,GASP,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC"}
|
package/dist/sdk/sdk-models.d.ts
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
* Shared query models/types intended to be reused across SDKs (e.g. Sync, Delivery, Management)
|
|
3
3
|
* to keep common code and behavior consistent.
|
|
4
4
|
*/
|
|
5
|
+
import z from "zod";
|
|
5
6
|
import type { AdapterResponse, HttpResponse, HttpService, PaginationConfig, RequestBody, ResponseData } from "../http/http.models.js";
|
|
6
7
|
import type { KontentSdkError } from "../models/error.models.js";
|
|
7
8
|
export type QueryResponseMeta<TMeta = unknown> = Pick<AdapterResponse, "status" | "responseHeaders" | "url"> & {
|
|
@@ -40,6 +41,7 @@ export type SdkConfig = {
|
|
|
40
41
|
};
|
|
41
42
|
};
|
|
42
43
|
export type Query<TResponsePayload, TMeta> = {
|
|
44
|
+
schema: z.ZodType<TResponsePayload>;
|
|
43
45
|
toUrl(): string;
|
|
44
46
|
toPromise(): Promise<QueryResult<QueryResponse<TResponsePayload, TMeta>>>;
|
|
45
47
|
};
|
|
@@ -83,6 +85,8 @@ export type PagingQueryResult<TResponsePayload> = (Success & {
|
|
|
83
85
|
readonly responses?: never;
|
|
84
86
|
readonly lastContinuationToken?: never;
|
|
85
87
|
});
|
|
88
|
+
export declare const nilUuid = "00000000-0000-0000-0000-000000000000";
|
|
89
|
+
export declare const kontentUuidSchema: z.ZodUnion<readonly [z.ZodUUID, z.ZodLiteral<"00000000-0000-0000-0000-000000000000">]>;
|
|
86
90
|
type Success = {
|
|
87
91
|
readonly success: true;
|
|
88
92
|
readonly error?: never;
|
package/dist/sdk/sdk-models.js
CHANGED
|
@@ -2,5 +2,7 @@
|
|
|
2
2
|
* Shared query models/types intended to be reused across SDKs (e.g. Sync, Delivery, Management)
|
|
3
3
|
* to keep common code and behavior consistent.
|
|
4
4
|
*/
|
|
5
|
-
|
|
5
|
+
import z from "zod";
|
|
6
|
+
export const nilUuid = "00000000-0000-0000-0000-000000000000";
|
|
7
|
+
export const kontentUuidSchema = z.union([z.uuid({ version: "v4" }), z.literal(nilUuid)]);
|
|
6
8
|
//# sourceMappingURL=sdk-models.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk-models.js","sourceRoot":"","sources":["../../lib/sdk/sdk-models.ts"],"names":[],"mappings":"AAAA;;;GAGG"}
|
|
1
|
+
{"version":3,"file":"sdk-models.js","sourceRoot":"","sources":["../../lib/sdk/sdk-models.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,CAAC,MAAM,KAAK,CAAC;AA2FpB,MAAM,CAAC,MAAM,OAAO,GAAG,sCAAsC,CAAC;AAE9D,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC"}
|
package/dist/sdk/sdk-query.d.ts
CHANGED
|
@@ -25,7 +25,7 @@ export type ResolveQueryData<TResponsePayload extends JsonValue, TRequestBody ex
|
|
|
25
25
|
readonly sdkInfo: SDKInfo;
|
|
26
26
|
readonly authorizationApiKey: string | undefined;
|
|
27
27
|
} & MetadataMapperConfig<TResponsePayload, TRequestBody, TMeta>;
|
|
28
|
-
export declare function createQuery<TResponsePayload extends JsonValue, TRequestBody extends RequestBody, TMeta>(data: Omit<ResolveQueryData<TResponsePayload, TRequestBody, TMeta>, "continuationToken" | "nextPageState" | "pageIndex">): Pick<Query<TResponsePayload, TMeta>, "toPromise">;
|
|
28
|
+
export declare function createQuery<TResponsePayload extends JsonValue, TRequestBody extends RequestBody, TMeta>(data: Omit<ResolveQueryData<TResponsePayload, TRequestBody, TMeta>, "continuationToken" | "nextPageState" | "pageIndex">): Pick<Query<TResponsePayload, TMeta>, "toPromise" | "schema">;
|
|
29
29
|
export declare function extractContinuationToken(responseHeaders: readonly Header[]): string | undefined;
|
|
30
30
|
export declare function resolveQueryAsync<TResponsePayload extends JsonValue, TRequestBody extends RequestBody, TMeta>({ config, request, mapMetadata, zodSchema, sdkInfo, authorizationApiKey, nextPageState, }: ResolveQueryData<TResponsePayload, TRequestBody, TMeta>): QueryPromiseResult<TResponsePayload, TMeta>;
|
|
31
31
|
export {};
|
package/dist/sdk/sdk-query.js
CHANGED
|
@@ -7,6 +7,7 @@ import { createSdkError } from "../utils/error.utils.js";
|
|
|
7
7
|
import { getSdkIdHeader } from "../utils/header.utils.js";
|
|
8
8
|
export function createQuery(data) {
|
|
9
9
|
return {
|
|
10
|
+
schema: data.zodSchema,
|
|
10
11
|
toPromise: async () => {
|
|
11
12
|
return await resolveQueryAsync({
|
|
12
13
|
...data,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk-query.js","sourceRoot":"","sources":["../../lib/sdk/sdk-query.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAGhE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AA4B1D,MAAM,UAAU,WAAW,CAC1B,IAAwH;IAExH,OAAO;QACN,SAAS,EAAE,KAAK,IAAI,EAAE;YACrB,OAAO,MAAM,iBAAiB,CAAwC;gBACrE,GAAG,IAAI;gBACP,aAAa,EAAE;oBACd,WAAW,EAAE,IAAI;oBACjB,UAAU,EAAE,cAAc;iBAC1B;aACD,CAAC,CAAC;QACJ,CAAC;KACD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,eAAkC;IAC1E,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAM,gBAAkD,CAAC,WAAW,EAAE,CAAC;QACvI,EAAE,KAAK,CAAC;AACV,CAAC;AAED,SAAS,cAAc,CAAC,MAAiB;IACxC,OAAO,MAAM,CAAC,WAAW,IAAI,qBAAqB,EAAE,CAAC;AACtD,CAAC;AAED,SAAS,yBAAyB,CAAC,EAClC,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,OAAO,GAMP;IACA,OAAO;QACN,cAAc,CAAC;YACd,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,OAAO,EAAE,OAAO,CAAC,OAAO;SACxB,CAAC;QACF,GAAG,cAAc;QACjB,GAAG,CAAC,iBAAiB;YACpB,CAAC,CAAC;gBACA;oBACC,IAAI,EAAE,gBAA4C;oBAClD,KAAK,EAAE,iBAAiB;iBACxB;aACD;YACF,CAAC,CAAC,EAAE,CAAC;QACN,GAAG,CAAC,mBAAmB;YACtB,CAAC,CAAC;gBACA;oBACC,IAAI,EAAE,eAA2C;oBACjD,KAAK,EAAE,UAAU,mBAAmB,EAAE;iBACtC;aACD;YACF,CAAC,CAAC,EAAE,CAAC;KACN,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAA8E,EACpH,MAAM,EACN,OAAO,EACP,WAAW,EACX,SAAS,EACT,OAAO,EACP,mBAAmB,EACnB,aAAa,GAC4C;IACzD,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC,YAAY,CAAiC;QAC9G,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,GAAG,EAAE,aAAa,EAAE,WAAW,IAAI,OAAO,CAAC,GAAG;QAC9C,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,cAAc,EAAE,yBAAyB,CAAC;YACzC,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,EAAE;YAC5C,iBAAiB,EAAE,aAAa,EAAE,iBAAiB;YACnD,mBAAmB,EAAE,mBAAmB;YACxC,OAAO;SACP,CAAC;KACF,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,OAAO;YACN,OAAO,EAAE,KAAK;YACd,KAAK;SACL,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,kBAAkB,EAAE,MAAM,EAAE,CAAC;QACvC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,GAAG,MAAM,2BAA2B,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC3G,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,OAAO;gBACN,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,cAAc,CAAC;oBACrB,OAAO,EAAE,+CAA+C,OAAO,CAAC,GAAG,GAAG;oBACtE,MAAM,EAAE,kBAAkB;oBAC1B,QAAQ,EAAE,eAAe;oBACzB,QAAQ;oBACR,GAAG,EAAE,OAAO,CAAC,GAAG;iBAChB,CAAC;aACF,CAAC;QACH,CAAC;IACF,CAAC;IAED,MAAM,6BAA6B,GAAG,wBAAwB,CAAC,QAAQ,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;IAEzG,MAAM,MAAM,GAAyD;QACpE,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE;YACT,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,IAAI,EAAE;gBACL,GAAG,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG;gBACjC,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC,eAAe;gBACzD,MAAM,EAAE,QAAQ,CAAC,eAAe,CAAC,MAAM;gBACvC,iBAAiB,EAAE,6BAA6B;gBAChD,GAAG,WAAW,CAAC,QAAQ,EAAE,EAAE,iBAAiB,EAAE,6BAA6B,EAAE,CAAC;aAC9E;SACD;KACD,CAAC;IAEF,OAAO,MAAM,CAAC;AACf,CAAC;AAED,KAAK,UAAU,2BAA2B,CACzC,OAAyB,EACzB,SAAoC;IAWpC,MAAM,cAAc,GAAG,MAAM,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAE/D,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;QAC5B,OAAO;YACN,OAAO,EAAE,IAAI;SACb,CAAC;IACH,CAAC;IAED,OAAO;QACN,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,cAAc,CAAC,KAAK;KAC3B,CAAC;AACH,CAAC"}
|
|
1
|
+
{"version":3,"file":"sdk-query.js","sourceRoot":"","sources":["../../lib/sdk/sdk-query.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAGhE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AA4B1D,MAAM,UAAU,WAAW,CAC1B,IAAwH;IAExH,OAAO;QACN,MAAM,EAAE,IAAI,CAAC,SAAS;QACtB,SAAS,EAAE,KAAK,IAAI,EAAE;YACrB,OAAO,MAAM,iBAAiB,CAAwC;gBACrE,GAAG,IAAI;gBACP,aAAa,EAAE;oBACd,WAAW,EAAE,IAAI;oBACjB,UAAU,EAAE,cAAc;iBAC1B;aACD,CAAC,CAAC;QACJ,CAAC;KACD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,eAAkC;IAC1E,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAM,gBAAkD,CAAC,WAAW,EAAE,CAAC;QACvI,EAAE,KAAK,CAAC;AACV,CAAC;AAED,SAAS,cAAc,CAAC,MAAiB;IACxC,OAAO,MAAM,CAAC,WAAW,IAAI,qBAAqB,EAAE,CAAC;AACtD,CAAC;AAED,SAAS,yBAAyB,CAAC,EAClC,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,OAAO,GAMP;IACA,OAAO;QACN,cAAc,CAAC;YACd,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,OAAO,EAAE,OAAO,CAAC,OAAO;SACxB,CAAC;QACF,GAAG,cAAc;QACjB,GAAG,CAAC,iBAAiB;YACpB,CAAC,CAAC;gBACA;oBACC,IAAI,EAAE,gBAA4C;oBAClD,KAAK,EAAE,iBAAiB;iBACxB;aACD;YACF,CAAC,CAAC,EAAE,CAAC;QACN,GAAG,CAAC,mBAAmB;YACtB,CAAC,CAAC;gBACA;oBACC,IAAI,EAAE,eAA2C;oBACjD,KAAK,EAAE,UAAU,mBAAmB,EAAE;iBACtC;aACD;YACF,CAAC,CAAC,EAAE,CAAC;KACN,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAA8E,EACpH,MAAM,EACN,OAAO,EACP,WAAW,EACX,SAAS,EACT,OAAO,EACP,mBAAmB,EACnB,aAAa,GAC4C;IACzD,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC,YAAY,CAAiC;QAC9G,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,GAAG,EAAE,aAAa,EAAE,WAAW,IAAI,OAAO,CAAC,GAAG;QAC9C,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,cAAc,EAAE,yBAAyB,CAAC;YACzC,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,EAAE;YAC5C,iBAAiB,EAAE,aAAa,EAAE,iBAAiB;YACnD,mBAAmB,EAAE,mBAAmB;YACxC,OAAO;SACP,CAAC;KACF,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,OAAO;YACN,OAAO,EAAE,KAAK;YACd,KAAK;SACL,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,kBAAkB,EAAE,MAAM,EAAE,CAAC;QACvC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,GAAG,MAAM,2BAA2B,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC3G,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,OAAO;gBACN,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,cAAc,CAAC;oBACrB,OAAO,EAAE,+CAA+C,OAAO,CAAC,GAAG,GAAG;oBACtE,MAAM,EAAE,kBAAkB;oBAC1B,QAAQ,EAAE,eAAe;oBACzB,QAAQ;oBACR,GAAG,EAAE,OAAO,CAAC,GAAG;iBAChB,CAAC;aACF,CAAC;QACH,CAAC;IACF,CAAC;IAED,MAAM,6BAA6B,GAAG,wBAAwB,CAAC,QAAQ,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;IAEzG,MAAM,MAAM,GAAyD;QACpE,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE;YACT,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,IAAI,EAAE;gBACL,GAAG,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG;gBACjC,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC,eAAe;gBACzD,MAAM,EAAE,QAAQ,CAAC,eAAe,CAAC,MAAM;gBACvC,iBAAiB,EAAE,6BAA6B;gBAChD,GAAG,WAAW,CAAC,QAAQ,EAAE,EAAE,iBAAiB,EAAE,6BAA6B,EAAE,CAAC;aAC9E;SACD;KACD,CAAC;IAEF,OAAO,MAAM,CAAC;AACf,CAAC;AAED,KAAK,UAAU,2BAA2B,CACzC,OAAyB,EACzB,SAAoC;IAWpC,MAAM,cAAc,GAAG,MAAM,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAE/D,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;QAC5B,OAAO;YACN,OAAO,EAAE,IAAI;SACb,CAAC;IACH,CAAC;IAED,OAAO;QACN,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,cAAc,CAAC,KAAK;KAC3B,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sdk-utils.js","sourceRoot":"","sources":["../../lib/sdk/sdk-utils.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,aAAa,CAAkB,KAA8C;IAC5F,OAAO,WAAW,IAAI,KAAK,IAAI,cAAc,IAAI,KAAK,IAAI,OAAO,IAAI,KAAK,CAAC;AAC5E,CAAC"}
|
package/dist/sdk-info.js
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"type.utils.js","sourceRoot":"","sources":["../../lib/utils/type.utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,UAAU,iBAAiB,CAA6C,SAAsB;IACnG,OAAO,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;AAC3E,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export function getEndpointUrl({ environmentId, path, baseUrl, }) {
|
|
2
|
+
return `${removeTrailingSlashes(baseUrl)}${removeDuplicateSlashes(`/${environmentId}/${path}`)}`;
|
|
3
|
+
}
|
|
4
|
+
function removeDuplicateSlashes(path) {
|
|
5
|
+
return path.replace(/\/+/g, "/");
|
|
6
|
+
}
|
|
7
|
+
function removeTrailingSlashes(path) {
|
|
8
|
+
return path.replace(/\/+$/, "");
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=url.utils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"url.utils.js","sourceRoot":"","sources":["../../lib/utils/url.utils.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,cAAc,CAAC,EAC9B,aAAa,EACb,IAAI,EACJ,OAAO,GAKP;IACA,OAAO,GAAG,qBAAqB,CAAC,OAAO,CAAC,GAAG,sBAAsB,CAAC,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;AAClG,CAAC;AAED,SAAS,sBAAsB,CAAC,IAAY;IAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAY;IAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACjC,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import chalk from "chalk";
|
|
2
|
+
|
|
3
|
+
export function getEnvironmentRequiredValue(variableName: string): string {
|
|
4
|
+
const value = getEnvironmentOptionalValue(variableName);
|
|
5
|
+
|
|
6
|
+
if (!value) {
|
|
7
|
+
throw new Error(`Missing environment variable '${chalk.red(variableName)}'`);
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
return value;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export function getEnvironmentOptionalValue(variableName: string): string | undefined {
|
|
14
|
+
return process.env[variableName];
|
|
15
|
+
}
|
package/lib/devkit_api.ts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
1
|
/** biome-ignore-all lint/performance/noBarrelFile: One barrel for exported API is fine */
|
|
2
|
+
|
|
3
|
+
export { getEnvironmentOptionalValue, getEnvironmentRequiredValue } from "./devkit/environment.utils.js";
|
|
2
4
|
export { deleteFolderRecursive } from "./devkit/script.utils.js";
|
|
3
5
|
export { replaceSdkVersionPlaceholder } from "./utils/sdk-version.utils.js";
|
|
@@ -1,15 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Improves the type readability by flattening the type.
|
|
3
|
-
*/
|
|
4
|
-
export type Prettify<T> = {
|
|
5
|
-
[K in keyof T]: T[K];
|
|
6
|
-
} & {};
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
* Override selected properties of a type. Uses Omit to remove the properties and then adds the new properties.
|
|
10
|
-
*/
|
|
11
|
-
export type Override<Type, NewType extends { [key in keyof Type]?: NewType[key] }> = Omit<Type, keyof NewType> & NewType;
|
|
12
|
-
|
|
13
1
|
/**
|
|
14
2
|
* Represents an empty object type.
|
|
15
3
|
*/
|
package/lib/public_api.ts
CHANGED
|
@@ -27,20 +27,25 @@ export type {
|
|
|
27
27
|
} from "./models/core.models.js";
|
|
28
28
|
export { type ErrorReason, type ErrorReasonData, KontentSdkError } from "./models/error.models.js";
|
|
29
29
|
export type { JsonArray, JsonObject, JsonValue } from "./models/json.models.js";
|
|
30
|
-
export type { EmptyObject
|
|
30
|
+
export type { EmptyObject } from "./models/utility.models.js";
|
|
31
31
|
export { createPagingQuery } from "./sdk/paging-sdk-query.js";
|
|
32
|
-
export
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
32
|
+
export {
|
|
33
|
+
kontentUuidSchema,
|
|
34
|
+
nilUuid,
|
|
35
|
+
type PagingQuery,
|
|
36
|
+
type PagingQueryResult,
|
|
37
|
+
type Query,
|
|
38
|
+
type QueryResponse,
|
|
39
|
+
type QueryResponseMeta,
|
|
40
|
+
type QueryResult,
|
|
41
|
+
type SdkConfig,
|
|
42
|
+
type SuccessfulHttpResponse,
|
|
41
43
|
} from "./sdk/sdk-models.js";
|
|
42
44
|
export { createQuery, extractContinuationToken } from "./sdk/sdk-query.js";
|
|
45
|
+
export { isPagingQuery } from "./sdk/sdk-utils.js";
|
|
43
46
|
export { isKontent404Error, isKontentSdkError } from "./utils/error.utils.js";
|
|
44
47
|
export { getSdkIdHeader } from "./utils/header.utils.js";
|
|
45
48
|
export { toRequiredRetryStrategyOptions } from "./utils/retry.utils.js";
|
|
46
49
|
export { tryCatch, tryCatchAsync } from "./utils/try.utils.js";
|
|
50
|
+
export { getCodenameSchema } from "./utils/type.utils.js";
|
|
51
|
+
export { getEndpointUrl } from "./utils/url.utils.js";
|
package/lib/sdk/sdk-models.ts
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
* to keep common code and behavior consistent.
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
|
+
import z from "zod";
|
|
6
7
|
import type { AdapterResponse, HttpResponse, HttpService, PaginationConfig, RequestBody, ResponseData } from "../http/http.models.js";
|
|
7
8
|
import type { KontentSdkError } from "../models/error.models.js";
|
|
8
9
|
|
|
@@ -47,6 +48,7 @@ export type SdkConfig = {
|
|
|
47
48
|
};
|
|
48
49
|
|
|
49
50
|
export type Query<TResponsePayload, TMeta> = {
|
|
51
|
+
schema: z.ZodType<TResponsePayload>;
|
|
50
52
|
toUrl(): string;
|
|
51
53
|
toPromise(): Promise<QueryResult<QueryResponse<TResponsePayload, TMeta>>>;
|
|
52
54
|
};
|
|
@@ -92,6 +94,10 @@ export type PagingQueryResult<TResponsePayload> =
|
|
|
92
94
|
| (Success & { readonly responses: TResponsePayload[]; readonly lastContinuationToken: string | undefined })
|
|
93
95
|
| (Failure & { readonly responses?: never; readonly lastContinuationToken?: never });
|
|
94
96
|
|
|
97
|
+
export const nilUuid = "00000000-0000-0000-0000-000000000000";
|
|
98
|
+
|
|
99
|
+
export const kontentUuidSchema = z.union([z.uuid({ version: "v4" }), z.literal(nilUuid)]);
|
|
100
|
+
|
|
95
101
|
type Success = {
|
|
96
102
|
readonly success: true;
|
|
97
103
|
readonly error?: never;
|
package/lib/sdk/sdk-query.ts
CHANGED
|
@@ -39,8 +39,9 @@ export type ResolveQueryData<TResponsePayload extends JsonValue, TRequestBody ex
|
|
|
39
39
|
|
|
40
40
|
export function createQuery<TResponsePayload extends JsonValue, TRequestBody extends RequestBody, TMeta>(
|
|
41
41
|
data: Omit<ResolveQueryData<TResponsePayload, TRequestBody, TMeta>, "continuationToken" | "nextPageState" | "pageIndex">,
|
|
42
|
-
): Pick<Query<TResponsePayload, TMeta>, "toPromise"> {
|
|
42
|
+
): Pick<Query<TResponsePayload, TMeta>, "toPromise" | "schema"> {
|
|
43
43
|
return {
|
|
44
|
+
schema: data.zodSchema,
|
|
44
45
|
toPromise: async () => {
|
|
45
46
|
return await resolveQueryAsync<TResponsePayload, TRequestBody, TMeta>({
|
|
46
47
|
...data,
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { PagingQuery, Query } from "./sdk-models.js";
|
|
2
|
+
|
|
3
|
+
export function isPagingQuery<T, TBody = null>(query: Query<T, TBody> | PagingQuery<T, TBody>): query is PagingQuery<T, TBody> {
|
|
4
|
+
return "toPromise" in query && "toAllPromise" in query && "pages" in query;
|
|
5
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export function getEndpointUrl({
|
|
2
|
+
environmentId,
|
|
3
|
+
path,
|
|
4
|
+
baseUrl,
|
|
5
|
+
}: {
|
|
6
|
+
readonly environmentId: string;
|
|
7
|
+
readonly path: string;
|
|
8
|
+
readonly baseUrl: string;
|
|
9
|
+
}): string {
|
|
10
|
+
return `${removeTrailingSlashes(baseUrl)}${removeDuplicateSlashes(`/${environmentId}/${path}`)}`;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
function removeDuplicateSlashes(path: string): string {
|
|
14
|
+
return path.replace(/\/+/g, "/");
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
function removeTrailingSlashes(path: string): string {
|
|
18
|
+
return path.replace(/\/+$/, "");
|
|
19
|
+
}
|