@servicenow/sdk-build-plugins 3.0.3 → 4.0.1

package/dist/scriptedRESTAPI/RestSchemaUtils.d.ts

@@ -1,190 +0,0 @@
-import { z } from 'zod';
-export declare const RestRouteHeaderMap: z.ZodObject<{
-    web_service_operation: z.ZodString;
-    web_service_header: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    web_service_header: string;
-    web_service_operation: string;
-}, {
-    web_service_header: string;
-    web_service_operation: string;
-}>;
-export declare const RestRouteQueryMap: z.ZodObject<{
-    web_service_operation: z.ZodString;
-    web_service_query_parameter: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    web_service_query_parameter: string;
-    web_service_operation: string;
-}, {
-    web_service_query_parameter: string;
-    web_service_operation: string;
-}>;
-export declare const RouteAttrWithOutIdSchema: z.ZodObject<Omit<{
-    $id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
-    name: z.ZodString;
-    required: z.ZodDefault<z.ZodBoolean>;
-    example_value: z.ZodDefault<z.ZodString>;
-    short_description: z.ZodDefault<z.ZodString>;
-}, "$id">, "strip", z.ZodTypeAny, {
-    name: string;
-    required: boolean;
-    short_description: string;
-    example_value: string;
-}, {
-    name: string;
-    required?: boolean | undefined;
-    short_description?: string | undefined;
-    example_value?: string | undefined;
-}>;
-export declare const VersionWithOutIdSchema: z.ZodObject<Omit<{
-    $id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
-    version: z.ZodNumber;
-    active: z.ZodDefault<z.ZodBoolean>;
-    deprecated: z.ZodDefault<z.ZodBoolean>;
-    short_description: z.ZodDefault<z.ZodString>;
-    is_default: z.ZodDefault<z.ZodBoolean>;
-}, "$id">, "strip", z.ZodTypeAny, {
-    active: boolean;
-    version: number;
-    deprecated: boolean;
-    is_default: boolean;
-    short_description: string;
-}, {
-    version: number;
-    active?: boolean | undefined;
-    deprecated?: boolean | undefined;
-    is_default?: boolean | undefined;
-    short_description?: string | undefined;
-}>;
-export declare const RestDefinitionTransformer: z.ZodEffects<z.ZodObject<{
-    name: z.ZodOptional<z.ZodString>;
-    active: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    short_description: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    consumes: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    produces: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    service_id: z.ZodOptional<z.ZodString>;
-    doc_link: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    enforce_acl: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    sys_policy: z.ZodOptional<z.ZodDefault<z.ZodEnum<["", "read", "protected"]>>>;
-}, "strip", z.ZodTypeAny, {
-    name?: string | undefined;
-    active?: boolean | undefined;
-    short_description?: string | undefined;
-    consumes?: string | undefined;
-    produces?: string | undefined;
-    service_id?: string | undefined;
-    doc_link?: string | undefined;
-    enforce_acl?: string | undefined;
-    sys_policy?: "" | "protected" | "read" | undefined;
-}, {
-    name?: string | undefined;
-    active?: boolean | undefined;
-    short_description?: string | undefined;
-    consumes?: string | undefined;
-    produces?: string | undefined;
-    service_id?: string | undefined;
-    doc_link?: string | undefined;
-    enforce_acl?: string | undefined;
-    sys_policy?: "" | "protected" | "read" | undefined;
-}>, {
-    policy?: "protected" | "read";
-    enforce_acl?: string[];
-    name?: string | undefined;
-    active?: boolean | undefined;
-    short_description?: string | undefined;
-    consumes?: string | undefined;
-    produces?: string | undefined;
-    service_id?: string | undefined;
-    doc_link?: string | undefined;
-}, {
-    name?: string | undefined;
-    active?: boolean | undefined;
-    short_description?: string | undefined;
-    consumes?: string | undefined;
-    produces?: string | undefined;
-    service_id?: string | undefined;
-    doc_link?: string | undefined;
-    enforce_acl?: string | undefined;
-    sys_policy?: "" | "protected" | "read" | undefined;
-}>;
-export declare const RestRouteTransformer: z.ZodEffects<z.ZodObject<{
-    name: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    active: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    short_description: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    consumes: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    produces: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    request_example: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    operation_script: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    http_method: z.ZodOptional<z.ZodDefault<z.ZodEnum<["GET", "POST", "PUT", "PATCH", "DELETE"]>>>;
-    relative_path: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    requires_acl_authorization: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    requires_authentication: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    requires_snc_internal_role: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    sys_policy: z.ZodOptional<z.ZodDefault<z.ZodEnum<["", "read", "protected"]>>>;
-    enforce_acl: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    web_service_version: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-}, "strip", z.ZodTypeAny, {
-    name?: string | undefined;
-    active?: boolean | undefined;
-    short_description?: string | undefined;
-    consumes?: string | undefined;
-    produces?: string | undefined;
-    request_example?: string | undefined;
-    operation_script?: string | undefined;
-    http_method?: "DELETE" | "GET" | "POST" | "PUT" | "PATCH" | undefined;
-    relative_path?: string | undefined;
-    requires_acl_authorization?: boolean | undefined;
-    requires_authentication?: boolean | undefined;
-    requires_snc_internal_role?: boolean | undefined;
-    sys_policy?: "" | "protected" | "read" | undefined;
-    enforce_acl?: string | undefined;
-    web_service_version?: string | undefined;
-}, {
-    name?: string | undefined;
-    active?: boolean | undefined;
-    short_description?: string | undefined;
-    consumes?: string | undefined;
-    produces?: string | undefined;
-    request_example?: string | undefined;
-    operation_script?: string | undefined;
-    http_method?: "DELETE" | "GET" | "POST" | "PUT" | "PATCH" | undefined;
-    relative_path?: string | undefined;
-    requires_acl_authorization?: boolean | undefined;
-    requires_authentication?: boolean | undefined;
-    requires_snc_internal_role?: boolean | undefined;
-    sys_policy?: "" | "protected" | "read" | undefined;
-    enforce_acl?: string | undefined;
-    web_service_version?: string | undefined;
-}>, {
-    policy?: "protected" | "read";
-    internalRole?: boolean;
-    authentication?: boolean;
-    authorization?: boolean;
-    path?: string;
-    method?: "DELETE" | "GET" | "POST" | "PUT" | "PATCH";
-    script?: string;
-    enforce_acl?: string[];
-    name?: string | undefined;
-    active?: boolean | undefined;
-    short_description?: string | undefined;
-    consumes?: string | undefined;
-    produces?: string | undefined;
-    request_example?: string | undefined;
-    web_service_version?: string | undefined;
-}, {
-    name?: string | undefined;
-    active?: boolean | undefined;
-    short_description?: string | undefined;
-    consumes?: string | undefined;
-    produces?: string | undefined;
-    request_example?: string | undefined;
-    operation_script?: string | undefined;
-    http_method?: "DELETE" | "GET" | "POST" | "PUT" | "PATCH" | undefined;
-    relative_path?: string | undefined;
-    requires_acl_authorization?: boolean | undefined;
-    requires_authentication?: boolean | undefined;
-    requires_snc_internal_role?: boolean | undefined;
-    sys_policy?: "" | "protected" | "read" | undefined;
-    enforce_acl?: string | undefined;
-    web_service_version?: string | undefined;
-}>;

package/dist/scriptedRESTAPI/RestSchemaUtils.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RestRouteTransformer = exports.RestDefinitionTransformer = exports.VersionWithOutIdSchema = exports.RouteAttrWithOutIdSchema = exports.RestRouteQueryMap = exports.RestRouteHeaderMap = void 0;
-const rest_1 = require("@servicenow/sdk-core/runtime/rest");
-const zod_1 = require("zod");
-exports.RestRouteHeaderMap = zod_1.z.object({
-    web_service_operation: zod_1.z.string(),
-    web_service_header: zod_1.z.string(),
-});
-exports.RestRouteQueryMap = zod_1.z.object({
-    web_service_operation: zod_1.z.string(),
-    web_service_query_parameter: zod_1.z.string(),
-});
-exports.RouteAttrWithOutIdSchema = rest_1.RouteAttributeSchema.omit({ $id: true });
-exports.VersionWithOutIdSchema = rest_1.VersionSchema.omit({ $id: true });
-const RestDefinitionSchema = rest_1.BaseRestApiSchema.omit({ $id: true }).extend({
-    enforce_acl: zod_1.z.string().default(''),
-    sys_policy: zod_1.z.enum(['', 'read', 'protected']).default(''),
-});
-exports.RestDefinitionTransformer = RestDefinitionSchema.partial().transform((data) => {
-    const { sys_policy, enforce_acl, ...rest } = data;
-    return {
-        ...rest,
-        ...(enforce_acl !== undefined && { enforce_acl: enforce_acl ? enforce_acl.split(',') : [] }),
-        ...(sys_policy && { policy: sys_policy }),
-    };
-});
-const RestRouteSchema = rest_1.BaseRouteSchema.omit({ $id: true }).extend({
-    operation_script: zod_1.z.string().default(''),
-    http_method: zod_1.z.enum(['GET', 'POST', 'PUT', 'PATCH', 'DELETE']).default('GET'),
-    relative_path: zod_1.z.string().default('/'),
-    requires_acl_authorization: zod_1.z.boolean().default(true),
-    requires_authentication: zod_1.z.boolean().default(true),
-    requires_snc_internal_role: zod_1.z.boolean().default(true),
-    sys_policy: zod_1.z.enum(['', 'read', 'protected']).default(''),
-    enforce_acl: zod_1.z.string().default(''),
-    web_service_version: zod_1.z.string().default(''),
-});
-exports.RestRouteTransformer = RestRouteSchema.partial().transform((data) => {
-    const { operation_script, http_method, relative_path, requires_acl_authorization, requires_authentication, requires_snc_internal_role, sys_policy, enforce_acl, ...rest } = data;
-    return {
-        ...rest,
-        ...(enforce_acl !== undefined && { enforce_acl: enforce_acl ? enforce_acl.split(',') : [] }),
-        ...(operation_script !== undefined && { script: operation_script }),
-        ...(http_method && { method: http_method }),
-        ...(relative_path && { path: relative_path }),
-        ...(requires_acl_authorization !== undefined && { authorization: requires_acl_authorization }),
-        ...(requires_authentication !== undefined && { authentication: requires_authentication }),
-        ...(requires_snc_internal_role !== undefined && { internalRole: requires_snc_internal_role }),
-        ...(sys_policy && { policy: sys_policy }),
-    };
-});
-//# sourceMappingURL=RestSchemaUtils.js.map

package/dist/scriptedRESTAPI/RestSchemaUtils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"RestSchemaUtils.js","sourceRoot":"","sources":["../../src/scriptedRESTAPI/RestSchemaUtils.ts"],"names":[],"mappings":";;;AAAA,4DAK0C;AAC1C,6BAAuB;AAEV,QAAA,kBAAkB,GAAG,OAAC,CAAC,MAAM,CAAC;IACvC,qBAAqB,EAAE,OAAC,CAAC,MAAM,EAAE;IACjC,kBAAkB,EAAE,OAAC,CAAC,MAAM,EAAE;CACjC,CAAC,CAAA;AAEW,QAAA,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACtC,qBAAqB,EAAE,OAAC,CAAC,MAAM,EAAE;IACjC,2BAA2B,EAAE,OAAC,CAAC,MAAM,EAAE;CAC1C,CAAC,CAAA;AAEW,QAAA,wBAAwB,GAAG,2BAAoB,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAA;AAEnE,QAAA,sBAAsB,GAAG,oBAAa,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAA;AAEvE,MAAM,oBAAoB,GAAG,wBAAiB,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;IACtE,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,UAAU,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CAC5D,CAAC,CAAA;AAEW,QAAA,yBAAyB,GAAG,oBAAoB,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;IACvF,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAA;IACjD,OAAO;QACH,GAAG,IAAI;QACP,GAAG,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC5F,GAAG,CAAC,UAAU,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;KAC5C,CAAA;AACL,CAAC,CAAC,CAAA;AAEF,MAAM,eAAe,GAAG,sBAAe,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;IAC/D,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACxC,WAAW,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC7E,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC;IACtC,0BAA0B,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IACrD,uBAAuB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IAClD,0BAA0B,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IACrD,UAAU,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACzD,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,mBAAmB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;CAC9C,CAAC,CAAA;AAEW,QAAA,oBAAoB,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;IAC7E,MAAM,EACF,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,0BAA0B,EAC1B,uBAAuB,EACvB,0BAA0B,EAC1B,UAAU,EACV,WAAW,EACX,GAAG,IAAI,EACV,GAAG,IAAI,CAAA;IACR,OAAO;QACH,GAAG,IAAI;QACP,GAAG,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC5F,GAAG,CAAC,gBAAgB,KAAK,SAAS,IAAI,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;QACnE,GAAG,CAAC,WAAW,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;QAC3C,GAAG,CAAC,aAAa,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;QAC7C,GAAG,CAAC,0BAA0B,KAAK,SAAS,IAAI,EAAE,aAAa,EAAE,0BAA0B,EAAE,CAAC;QAC9F,GAAG,CAAC,uBAAuB,KAAK,SAAS,IAAI,EAAE,cAAc,EAAE,uBAAuB,EAAE,CAAC;QACzF,GAAG,CAAC,0BAA0B,KAAK,SAAS,IAAI,EAAE,YAAY,EAAE,0BAA0B,EAAE,CAAC;QAC7F,GAAG,CAAC,UAAU,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;KAC5C,CAAA;AACL,CAAC,CAAC,CAAA"}

package/dist/scriptedRESTAPI/RestUtils.d.ts

@@ -1,69 +0,0 @@
-import { ts } from '@servicenow/sdk-project';
-import { Context, Document, Result, DocumentPointer, EntityData } from '@servicenow/sdk-build-core';
-import { SupportedNode } from '@servicenow/sdk-project';
-export declare const restTables: string[];
-export declare function getRouteAttrMapResult(document: Document, restDocMap: any): Result<DocumentPointer | undefined>;
-/** utility function to get the args node of a call expression node*/
-export declare const getArgs: (document: Document) => ts.ObjectLiteralExpression;
-/**
- * keeps track of all those params records associated with a rest node,
- * so if some m2m records removes all its associations then we would create record call.
- */
-export declare const potentialRecordCallRouteParams: Set<string>;
-/**
- * There are some of the completely unassociated param records generated when an
- * m2m record swtiches from one rest to another rest entity. we track them to generate records calls
- * if required.
- */
-export declare const completelyUnassociatedParamIds: Set<string>;
-/**
- * Ids of records which are going to be a record call so need not handle them in rest generator.
- */
-export declare const unHandledIds: string[];
-/** Based on the result it adds the document id to unHandledIds which is later on used by generator
- *  to avoid generating nodes for them since it's expected to be handled by record plugin.
- */
-export declare function handleAndReturnResult(result: Result<DocumentPointer | undefined>, document: Document): Result<DocumentPointer | undefined>;
-/**
- * Performs the following operations:
- * 1. If the documents associated rest node is the same as the referenced rest in data, let the rest node handle it.
- * 2. If it refernces a different rest node, then clean up the current rest node and its keys. If the referenced rest node
- *    has a mapping record to consume this parameter or header let it handle, else make it a record call.
- */
-export declare function getRouteAttrWithRestNodeResult(document: Document, context: Context, restDocMap: any): Result<DocumentPointer | undefined>;
-/**
- * checks to see if the document is consumed by any rest api. If consumed then
- * remove that record call expression and its associated keys and let rest handle
- * it, else update the record call.
- */
-export declare function getRouteAttrWithRecordNodeResult(document: Document, context: Context, restDocMap: any): Result<DocumentPointer | undefined>;
-/**
- * Performs the following operations:
- * 1. If the mapping record references a differnt route or query param not part of the app
- *    then clean its presence from current rest node and create a record call for it.
- * 2. If if references a different route and query param in same app, the clean current rest
- *    and update the new rest node.
- * 3. If references same rest then update it.
- *
- * In addition to that, it also tracks the params unassociated to create record call if needed.
- */
-export declare function getRouteAttrMapWithRestNodeResult(document: Document, context: Context, restDocMap: any): Result<DocumentPointer | undefined>;
-/**
- * Performs following operation
- * 1. If given mapping record references some routes or param not in app update the record call.
- * 2. If references some existing route and param, then remove the current record call and its keys.
- *    Update the new rest node.
- */
-export declare function getRouteAttrMapWithRecordNodeResult(document: Document, context: Context, restDocMap: any): Result<DocumentPointer | undefined>;
-/**
- * If the incoming parameter or header record is consumed by rest associated it to the rest node, else make it a record call.
- */
-export declare function getRouteAttrResult(document: Document, restDocMap: any): Result<DocumentPointer | undefined>;
-export declare function getRestDocumentMap(context: Context): any;
-export declare function isParamAssociated(document: Document, eleAttrName: string, context: Context, paramSysId: string): boolean;
-/**
- * Helper function that creates a record call for the document passed.
- */
-export declare function createRecordCall(paramSysId: string, context: Context): void;
-export declare function removeNodeAndCleanUpExport(node: SupportedNode): void;
-export declare function extractNestedIds(entity: EntityData): string[];