@or-sdk/library-types-v1 6.0.8 → 6.0.10

package/dist/types/Packages/param.d.ts

@@ -138,6 +138,7 @@ export declare const GetPackagesQuery: z.ZodIntersection<z.ZodObject<{
     }>>;
     categories: z.ZodDefault<z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodArray<z.ZodString, "many">, z.ZodString]>, unknown[], string | string[]>>>;
     includeDeprecated: z.ZodDefault<z.ZodUnion<[z.ZodEffects<z.ZodString, boolean, string>, z.ZodBoolean]>>;
+    includePrerelease: z.ZodDefault<z.ZodUnion<[z.ZodEffects<z.ZodString, boolean, string>, z.ZodBoolean]>>;
 }, "strip", z.ZodTypeAny, {
     id?: unknown[];
     type?: "TEST_ONLY" | "UNKNOWN" | "STEP" | "STEP_INPUT" | "STEP_TEMPLATE" | "FLOW_TEMPLATE" | "BOT_TEMPLATE" | "TICKET_INPUT" | "CONTENT_INPUT" | "CONTENT" | "NPM_UNPACKED" | "S3_BUCKET" | "RWC_INPUT";
@@ -154,6 +155,7 @@ export declare const GetPackagesQuery: z.ZodIntersection<z.ZodObject<{
     order?: "asc" | "desc";
     categories?: unknown[];
     includeDeprecated?: boolean;
+    includePrerelease?: boolean;
 }, {
     id?: string | string[];
     type?: "TEST_ONLY" | "UNKNOWN" | "STEP" | "STEP_INPUT" | "STEP_TEMPLATE" | "FLOW_TEMPLATE" | "BOT_TEMPLATE" | "TICKET_INPUT" | "CONTENT_INPUT" | "CONTENT" | "NPM_UNPACKED" | "S3_BUCKET" | "RWC_INPUT";
@@ -168,6 +170,7 @@ export declare const GetPackagesQuery: z.ZodIntersection<z.ZodObject<{
     order?: "asc" | "desc";
     categories?: string | string[];
     includeDeprecated?: string | boolean;
+    includePrerelease?: string | boolean;
 }>>>;
 export declare const PackageParamUniversal: z.ZodObject<{
     type: z.ZodNativeEnum<{

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@or-sdk/library-types-v1",
-  "version": "6.0.8",
+  "version": "6.0.10",
   "description": "Request/response v1 legacy types for the OR SDK",
   "files": [
     "./dist",
-    "./src",
     "CHANGELOG.md"
   ],
   "private": false,

package/src/Categories/body.ts

@@ -1,21 +0,0 @@
-import { z } from 'zod';
-
-const uuidRegex = new RegExp(
-  /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/,
-);
-
-export const CategoryNameType = z
-  .string()
-  .trim()
-  .refine((s) => !uuidRegex.test(s), {
-    message: 'Category name cannot be uuid',
-  });
-
-export const CreateCategoryBody = z.object({
-  name: CategoryNameType,
-});
-
-export const UpdateCategoryBody = z.object({
-  name: CategoryNameType,
-  hidden: z.boolean().optional(),
-});

package/src/Categories/index.ts

@@ -1,3 +0,0 @@
-export * from './body';
-export * from './param';
-export * from './response';

package/src/Categories/param.ts

@@ -1,7 +0,0 @@
-import { z } from 'zod';
-import { PackageTypeEnum } from '@or-sdk/library-prisma';
-
-export const CategoriesParamUniversal = z.object({
-  type: z.nativeEnum(PackageTypeEnum),
-  id: z.string().uuid(),
-});

package/src/Categories/response.ts

@@ -1,14 +0,0 @@
-import { PackageTypeEnum } from '@or-sdk/library-prisma';
-import { z } from 'zod';
-
-export const CategoryItemResponse = z.object({
-  id: z.string(),
-  name: z.string(),
-  hidden: z.boolean().optional(),
-  type: z.nativeEnum(PackageTypeEnum).optional(),
-});
-
-export const CategoryListResponse = z.object({
-  categories: z.array(CategoryItemResponse),
-  type: z.nativeEnum(PackageTypeEnum).optional(),
-});

package/src/PackageMeta.ts

@@ -1,19 +0,0 @@
-import { z } from 'zod';
-
-export const PackageMeta = z
-  .object({
-    label: z.string().trim().optional(),
-    name: z.string().trim().optional(),
-    id: z.string().trim().optional(),
-    version: z.string().trim().optional(),
-    categories: z.array(z.string()).optional(),
-    description: z.string().trim().nullable().optional(),
-    icon: z.string().trim().nullable().optional(),
-    iconType: z.string().trim().nullable().optional(),
-    recommendedSteps: z.array(z.string()).nullable().optional(),
-    shape: z.string().trim().nullable().optional(),
-    tags: z.array(z.string().trim()).nullable().optional(),
-  })
-  .passthrough()
-  .nullable()
-  .default({});

package/src/Packages/body.ts

@@ -1,100 +0,0 @@
-import {
-  PackageSchemaTypeEnum,
-  PackageStatusDetailsLevelEnum,
-  PackageStatusDetailsStatusEnum,
-} from '@or-sdk/library-prisma';
-import { PackageMeta } from '../PackageMeta';
-import { z } from 'zod';
-
-export const CreatePackageByVersionBody = z
-  .object({
-    fileName: z.string().trim().optional(),
-    fileNames: z.array(z.string()).optional(),
-    name: z.string().trim().optional(),
-    label: z.string().trim().optional(),
-    description: z.string().optional(),
-    categories: z.array(z.string()).optional(),
-    packageMeta: PackageMeta,
-    revisionId: z.string().optional(),
-    status: z
-      .nativeEnum(PackageStatusDetailsStatusEnum)
-      .default(PackageStatusDetailsStatusEnum.BETA)
-      .optional(),
-    level: z
-      .nativeEnum(PackageStatusDetailsLevelEnum)
-      .default(PackageStatusDetailsLevelEnum.ACCOUNT)
-      .optional(),
-    servingType: z
-      .string()
-      .optional()
-      .transform((s) => s?.toUpperCase?.()),
-  })
-  .transform((body) => {
-    body.label = body.label || body.name;
-
-    return body;
-  });
-
-export const CreatePackageReleaseBody = z
-  .object({
-    status: z
-      .string()
-      .transform(
-        (status) => PackageStatusDetailsStatusEnum?.[status?.toUpperCase?.()],
-      )
-      .optional(),
-    releaseNotes: z
-      .union([
-        z.string(),
-        z
-          .object({
-            markdown: z.string().optional(),
-          })
-          .transform((s) => s?.markdown || ''),
-      ])
-      .transform((s) => s?.trim?.() || s)
-      .optional(),
-    membersAccountIds: z.array(z.string()).optional(),
-    membersUserIds: z.array(z.string()).optional(),
-    member: z
-      .object({
-        account: z
-          .array(
-            z.object({
-              accountId: z.string(),
-            }),
-          )
-          .optional(),
-      })
-      .optional(),
-  })
-  .transform((body) => {
-    if (!body?.membersAccountIds?.length) {
-      body.membersAccountIds =
-        body.member?.account.map((e) => e.accountId) || [];
-    }
-
-    return body;
-  });
-
-export const CreatePackageFromJsonBody = z.object({
-  name: z.string(),
-  description: z.string(),
-  categories: z.array(z.string()).optional(),
-  packageMeta: PackageMeta,
-  data: z.any().optional(),
-  schemaType: z.nativeEnum(PackageSchemaTypeEnum),
-  isBeta: z.boolean().optional(),
-});
-
-export const DeprecateLegacyStepsBody = z.object({
-  exclude: z.array(z.object({ id: z.string() })).default([]),
-  include: z.array(z.object({ id: z.string() })).default([]),
-});
-
-export const PutLegacyPackageBody = z.object({
-  name: z.string().default(''),
-  description: z.string().default(''),
-  categories: z.array(z.string()).default([]),
-  data: z.any().default({}),
-});

package/src/Packages/index.ts

@@ -1,7 +0,0 @@
-export * from './param';
-
-export * from './body';
-
-export * from './union';
-
-export * from './response';

package/src/Packages/param.ts

@@ -1,157 +0,0 @@
-import {
-  Prisma,
-  PackageSchemaTypeEnum,
-  PackageTypeEnum,
-  PackageStatusDetailsLevelEnum,
-} from '@or-sdk/library-prisma';
-import { z } from 'zod';
-import { packageLevel, packageStatus } from './propTransformer';
-
-function clearArray<T>(arr = []): T[] {
-  return arr
-    .map((e) => e?.trim?.())
-    .filter(
-      (item) =>
-        ['', 'undefined', 'false', 'true', 'null'].indexOf(`${item}`) === -1,
-    ) as T[];
-}
-
-export enum PackagesOrderByEnum {
-  createdAt = 'createdAt',
-  created = 'created', // override
-  updatedAt = 'updatedAt',
-}
-
-const PackageArrayOfStringParam = z
-  .array(z.string())
-  .or(z.string())
-  .transform((data) => {
-    if (!Array.isArray(data)) {
-      data = [data];
-    }
-    return clearArray(data);
-  })
-  .optional()
-  .default([]);
-
-export const GetPackagesQueryFilter = z.object({
-  filter: z
-    .object({
-      id: PackageArrayOfStringParam,
-      schemaType: z.nativeEnum(PackageSchemaTypeEnum).optional(),
-      category: PackageArrayOfStringParam,
-      level: z
-        .array(z.nativeEnum(PackageStatusDetailsLevelEnum))
-        .or(
-          z
-            .nativeEnum(PackageStatusDetailsLevelEnum)
-            .transform((data) => [data]),
-        )
-        .default([
-          PackageStatusDetailsLevelEnum.PDE,
-          PackageStatusDetailsLevelEnum.ACCOUNT,
-        ])
-        .transform((data) => (Array.isArray(data) ? data : [data])),
-    })
-    .default({}),
-});
-
-export const GetPackagesQuery = z.intersection(
-  GetPackagesQueryFilter,
-  z
-    .object({
-      id: PackageArrayOfStringParam,
-      type: z.nativeEnum(PackageTypeEnum).optional(),
-      query: z
-        .string()
-        .optional()
-        .transform((s) => (typeof s === 'string' ? s.trim() : s)),
-      scope: z
-        .object({
-          id: PackageArrayOfStringParam,
-          category: PackageArrayOfStringParam,
-        })
-        .default({}),
-      size: z
-        .number()
-        .or(z.string())
-        .default(10)
-        .transform((n) => Number(n) || 0),
-      cursor: z
-        .object({
-          from: z
-            .number()
-            .or(z.string())
-            .transform((n) => Number(n) || 0),
-        })
-        .or(z.any().transform(() => ({ from: 0 })))
-        .transform((data) => (data?.from ? data : { from: 0 })),
-      orderBy: z
-        .nativeEnum(PackagesOrderByEnum)
-        .default(PackagesOrderByEnum.createdAt)
-        .transform((data) => {
-          if (data === PackagesOrderByEnum.created) {
-            return PackagesOrderByEnum.createdAt;
-          }
-          return data;
-        }),
-      order: z.nativeEnum(Prisma.SortOrder).default(Prisma.SortOrder.desc),
-      categories: PackageArrayOfStringParam,
-      includeDeprecated: z
-        .string()
-        .transform((v) => ['true', '1', 1, true].includes(v))
-        .or(z.boolean())
-        .default(false),
-    })
-    .default({}),
-);
-
-export const PackageParamUniversal = z.object({
-  type: z.nativeEnum(PackageTypeEnum),
-  id: z.string(),
-  version: z.string().optional(),
-  revisionId: z.string().optional(),
-});
-
-export const CreateReleaseParams = z.object({
-  type: z.nativeEnum(PackageTypeEnum),
-  id: z.string(),
-  revisionId: z.string().optional(),
-  version: z.string().optional(),
-  level: packageLevel,
-});
-
-export const PackageParamNpmScope = z.object({
-  npmScope: z.string(),
-});
-
-export const PackageIncludesParams = z.object({
-  includeDeprecated: z
-    .string()
-    .transform((v) => ['true', '1', 1, true].includes(v))
-    .or(z.boolean())
-    .default(true),
-  includeMember: z
-    .string()
-    .transform((v) => ['true', '1', 1, true].includes(v))
-    .or(z.boolean())
-    .default(true),
-  includeReleaseNotes: z
-    .string()
-    .transform((v) => ['true', '1', 1, true].includes(v))
-    .or(z.boolean())
-    .default(true),
-  includeData: z
-    .string()
-    .transform((v) => ['true', '1', 1, true].includes(v))
-    .or(z.boolean())
-    .default(true),
-});
-
-export const PackageSetSystemStatusParams = z.object({
-  type: z.nativeEnum(PackageTypeEnum),
-  id: z.string(),
-  version: z.string().optional(),
-  revisionId: z.string().optional(),
-  status: packageStatus,
-});

package/src/Packages/propTransformer.ts

@@ -1,17 +0,0 @@
-import { z } from 'zod';
-import {
-  PackageStatusDetailsLevelEnum,
-  PackageStatusDetailsStatusEnum,
-} from '@or-sdk/library-prisma';
-
-export const packageStatus = z
-  .string()
-  .trim()
-  .toUpperCase()
-  .transform((status) => PackageStatusDetailsStatusEnum?.[status] || null);
-
-export const packageLevel = z
-  .string()
-  .trim()
-  .toUpperCase()
-  .transform((level) => PackageStatusDetailsLevelEnum?.[level] || null);

package/src/Packages/response.ts

@@ -1,217 +0,0 @@
-import {
-  PackageSchemaTypeEnum,
-  PackageStatusDetailsLevelEnum,
-  PackageStatusDetailsStatusEnum,
-  PackageTypeEnum,
-} from '@or-sdk/library-prisma';
-import { PackageMeta } from '../PackageMeta';
-import { z } from 'zod';
-
-const categoriesList = z.array(
-  z.object({
-    id: z.string().nullable(),
-    count: z.number(),
-    name: z.string().optional(),
-  }),
-);
-
-const PackageReleases = z
-  .array(
-    z.object({
-      status: z.nativeEnum(PackageStatusDetailsStatusEnum),
-      level: z.nativeEnum(PackageStatusDetailsLevelEnum),
-      version: z.string(),
-      primaryId: z.number().optional(),
-    }),
-  )
-  .default([]);
-
-export const GetPackagesResponseEntity = z.object({
-  createdAt: z.date().or(z.string()).optional(),
-  id: z.string(),
-  isExternal: z.boolean().optional(),
-  isSandbox: z.boolean().optional(), // TODO: remove this after frontend will be updated #SA-32
-  isPlayground: z.boolean().optional(),
-  latest: PackageMeta,
-  latestVersion: z.string().optional(),
-  level: z.nativeEnum(PackageStatusDetailsLevelEnum).optional(),
-  levels: z.array(z.nativeEnum(PackageStatusDetailsLevelEnum)).optional(),
-  name: z.string().optional(),
-  releases: PackageReleases,
-  latestDocId: z.any().optional(),
-  revisionId: z.string().optional(),
-  schemaType: z.nativeEnum(PackageSchemaTypeEnum),
-  status: z.string().optional(),
-  statuses: z.array(z.string()).optional(),
-  type: z.nativeEnum(PackageTypeEnum).optional(),
-  versions: z.array(z.string()),
-});
-
-export const GetPackagesResponse = z.object({
-  entities: z.array(GetPackagesResponseEntity),
-  total: z.number().optional(),
-  count: z.number().optional(), // TODO: remove this
-  offset: z.number().optional(),
-  limit: z.number().optional(),
-  cursor: z.object({
-    from: z.number(),
-  }),
-  categories: categoriesList,
-  all: z.object({
-    categories: categoriesList,
-    count: z.number(),
-  }),
-});
-
-export const PackageStatusDetails = z
-  .object({
-    release: z.object({
-      pde: z
-        .object({
-          status: z.array(z.nativeEnum(PackageStatusDetailsStatusEnum)),
-        })
-        .optional(),
-      user: z
-        .object({
-          status: z.array(z.nativeEnum(PackageStatusDetailsStatusEnum)),
-        })
-        .optional(),
-      account: z
-        .object({
-          status: z.array(z.nativeEnum(PackageStatusDetailsStatusEnum)),
-        })
-        .optional(),
-    }),
-    system: z
-      .object({
-        status: z.array(z.nativeEnum(PackageStatusDetailsStatusEnum)),
-      })
-      .optional(),
-  })
-  .optional();
-
-export const GetPackageResponse = z.object({
-  baseUrl: z.string(),
-  data: z.any(),
-  packageMeta: PackageMeta,
-  id: z.string(),
-  version: z.string(),
-  schemaType: z.nativeEnum(PackageSchemaTypeEnum),
-  revisionId: z.string().optional(),
-  status: z.nativeEnum(PackageStatusDetailsStatusEnum).optional(),
-  level: z.nativeEnum(PackageStatusDetailsLevelEnum).optional(),
-  name: z.string(),
-  description: z.string().nullable().optional(),
-  categories: z.array(z.string()).optional(),
-  statusDetails: PackageStatusDetails,
-  servingType: z.string().optional(),
-});
-
-export const GetPackageByIdIncludes = z.object({
-  releaseNotes: z
-    .object({ markdown: z.string().nullable().optional() })
-    .optional()
-    .optional(),
-  member: z
-    .object({
-      account: z
-        .array(
-          z.object({
-            accountId: z.string(),
-          }),
-        )
-        .optional(),
-      user: z
-        .array(
-          z.object({
-            userId: z.string(),
-          }),
-        )
-        .optional(),
-    })
-    .optional()
-    .describe('Deprecated for v2 version api'),
-  membersAccountIds: z.array(z.string()).optional(),
-  membersUserIds: z.array(z.string()).optional(),
-});
-
-export const GetPackageByIdResponse = z.intersection(
-  z.object({
-    version: z.string(),
-    baseUrl: z.string(),
-    statusDetails: PackageStatusDetails.optional(),
-    servingType: z.string().optional(),
-    createdAt: z.date().or(z.string()).optional(),
-    revisionId: z.string().optional(),
-    name: z.string().optional(),
-    description: z.string().nullable().optional(),
-    categories: z.array(z.string()).optional(),
-    packageMeta: PackageMeta,
-    id: z.string().optional(),
-    schemaType: z.nativeEnum(PackageSchemaTypeEnum).optional(),
-  }),
-  GetPackageByIdIncludes,
-);
-
-export const GetPackageByIdLatestResponse = z.intersection(
-  z.object({
-    packageMeta: PackageMeta,
-    id: z.string(),
-    schemaType: z.nativeEnum(PackageSchemaTypeEnum),
-    version: z.string(),
-    name: z.string().trim().optional(),
-    baseUrl: z.string(),
-    servingType: z.string().optional(),
-    releases: PackageReleases,
-  }),
-  GetPackageByIdIncludes,
-);
-
-export const GetPackageArchiveSignedUrl = z.object({
-  key: z.string(),
-  url: z.string(),
-});
-
-export const CreatePackageByVersionFileNamesResponse = z
-  .array(
-    z.object({
-      fileName: z.string(),
-      url: z.string(),
-      fields: z.any(),
-    }),
-  )
-  .optional()
-  .describe(
-    'When you upload a package with multiple files, this field will be returned',
-  );
-
-export const CreatePackageByVersionResponse = z.object({
-  revisionId: z.string().optional(),
-  isExists: z.boolean().optional(),
-  fileNames: CreatePackageByVersionFileNamesResponse,
-  url: z
-    .string()
-    .optional()
-    .describe(
-      'When you upload a package with a single file, this field will be returned',
-    ),
-  fields: z
-    .any()
-    .optional()
-    .describe(
-      'When you upload a package with a single file, this field will be returned',
-    ),
-});
-
-export const GetPackageSystemStatusResponse = z.object({
-  createdAt: z.date().or(z.string()),
-  id: z.string(),
-  revisionId: z.string(),
-  statusDetailsSystem: z.array(
-    z.object({
-      status: z.nativeEnum(PackageStatusDetailsStatusEnum),
-    }),
-  ),
-  type: z.nativeEnum(PackageTypeEnum),
-  version: z.string(),
-});

package/src/Packages/union.ts

@@ -1,41 +0,0 @@
-import { PackageSchemaTypeEnum } from '@or-sdk/library-prisma';
-import {
-  CreatePackageReleaseBody,
-  CreatePackageFromJsonBody,
-  CreatePackageByVersionBody,
-} from './body';
-import {
-  PackageParamUniversal,
-  CreateReleaseParams,
-  GetPackagesQueryFilter,
-  PackageIncludesParams,
-} from './param';
-import { z } from 'zod';
-import { packageLevel, packageStatus } from './propTransformer';
-
-export const CreateReleaseUnion = z.intersection(
-  CreatePackageReleaseBody,
-  CreateReleaseParams,
-);
-export const CreatePackageFromJsonUnion = z.intersection(
-  PackageParamUniversal,
-  CreatePackageFromJsonBody,
-);
-
-export const StatusDetailsReleaseParam = z.object({
-  statusDetailsReleaseData: z.object({
-    status: packageStatus,
-    level: packageLevel,
-  }),
-  schemaType: z.nativeEnum(PackageSchemaTypeEnum),
-});
-
-export const CreatePackageByVersionUnion = z.intersection(
-  z.intersection(PackageParamUniversal, CreatePackageByVersionBody),
-  StatusDetailsReleaseParam,
-);
-
-export const GetPackageByIdQueryUnion = z.intersection(
-  GetPackagesQueryFilter,
-  PackageIncludesParams,
-);