@or-sdk/library-types-v1 6.0.6 → 6.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/library-types-v1",
-  "version": "6.0.6",
+  "version": "6.0.7",
   "description": "Request/response v1 legacy types for the OR SDK",
   "files": [
     "./dist",

package/src/Categories/body.ts

@@ -1,10 +1,21 @@
 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: z.string().trim(),
+  name: CategoryNameType,
 });
 
 export const UpdateCategoryBody = z.object({
-  name: z.string().trim(),
+  name: CategoryNameType,
   hidden: z.boolean().optional(),
 });

package/src/Packages/param.ts

@@ -7,7 +7,7 @@ import {
 import { z } from 'zod';
 import { packageLevel, packageStatus } from './propTransformer';
 
-function clearArray<T>(arr = []) {
+function clearArray<T>(arr = []): T[] {
   return arr
     .map((e) => e?.trim?.())
     .filter(
@@ -22,20 +22,24 @@ export enum PackagesOrderByEnum {
   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: z
-        .array(z.string())
-        .or(z.string())
-        .transform((data) => clearArray(Array.isArray(data) ? data : [data]))
-        .default([]),
+      id: PackageArrayOfStringParam,
       schemaType: z.nativeEnum(PackageSchemaTypeEnum).optional(),
-      category: z
-        .array(z.string())
-        .or(z.string())
-        .default([])
-        .transform((data) => (Array.isArray(data) ? data : [data])),
+      category: PackageArrayOfStringParam,
       level: z
         .array(z.nativeEnum(PackageStatusDetailsLevelEnum))
         .or(
@@ -52,83 +56,55 @@ export const GetPackagesQueryFilter = z.object({
     .default({}),
 });
 
-export const GetPackagesQuery = z
-  .intersection(
-    GetPackagesQueryFilter,
-    z
-      .object({
-        id: z
-          .string()
-          .optional()
-          .transform((s) => s?.trim?.() || s || false),
-        type: z.nativeEnum(PackageTypeEnum).optional(),
-        query: z
-          .string()
-          .optional()
-          .transform((s) => (typeof s === 'string' ? s.trim() : s)),
-        scope: z
-          .object({
-            id: z
-              .array(z.string())
-              .or(z.string())
-              .transform((data) =>
-                clearArray(Array.isArray(data) ? data : [data]),
-              )
-              .default([]),
-            category: z
-              .array(z.string())
-              .or(z.string())
-              .transform((data) =>
-                clearArray(Array.isArray(data) ? data : [data]),
-              )
-              .default([]),
-          })
-          .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: z
-          .array(z.string())
-          .default([])
-          .transform((data) => clearArray(data)),
-        includeDeprecated: z
-          .string()
-          .transform((v) => ['true', '1', 1, true].includes(v))
-          .or(z.boolean())
-          .default(false),
-      })
-      .default({}),
-  )
-  .transform((data) => {
-    return {
-      ...data,
-      categories: [
-        ...(data.scope?.category || []),
-        ...(data.filter?.category || []),
-      ],
-    };
-  });
+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),

package/src/Packages/response.ts

@@ -15,6 +15,17 @@ const categoriesList = z.array(
   }),
 );
 
+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(),
@@ -26,16 +37,7 @@ export const GetPackagesResponseEntity = z.object({
   level: z.nativeEnum(PackageStatusDetailsLevelEnum).optional(),
   levels: z.array(z.nativeEnum(PackageStatusDetailsLevelEnum)).optional(),
   name: z.string().optional(),
-  releases: z
-    .array(
-      z.object({
-        status: z.nativeEnum(PackageStatusDetailsStatusEnum),
-        level: z.nativeEnum(PackageStatusDetailsLevelEnum),
-        version: z.string(),
-        primaryId: z.number().optional(),
-      }),
-    )
-    .optional(),
+  releases: PackageReleases,
   latestDocId: z.any().optional(),
   revisionId: z.string().optional(),
   schemaType: z.nativeEnum(PackageSchemaTypeEnum),
@@ -105,11 +107,7 @@ export const GetPackageResponse = z.object({
   servingType: z.string().optional(),
 });
 
-export const GetPackageByIdResponse = z.object({
-  version: z.string(),
-  baseUrl: z.string(),
-  statusDetails: PackageStatusDetails.optional(),
-  servingType: z.string().optional(),
+export const GetPackageByIdIncludes = z.object({
   releaseNotes: z
     .object({ markdown: z.string().nullable().optional() })
     .optional()
@@ -135,25 +133,39 @@ export const GetPackageByIdResponse = z.object({
     .describe('Deprecated for v2 version api'),
   membersAccountIds: z.array(z.string()).optional(),
   membersUserIds: z.array(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(),
 });
 
-export const GetPackageByIdLatestResponse = 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(),
-});
+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(),

package/src/index.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import * as allZodSchemas from './index.zod';
+export type CategoryNameTypeDTO = z.infer<typeof allZodSchemas.CategoryNameType>
 export type CreateCategoryBodyDTO = z.infer<typeof allZodSchemas.CreateCategoryBody>
 export type UpdateCategoryBodyDTO = z.infer<typeof allZodSchemas.UpdateCategoryBody>
 export type CategoriesParamUniversalDTO = z.infer<typeof allZodSchemas.CategoriesParamUniversal>
@@ -26,6 +27,7 @@ export type GetPackagesResponseEntityDTO = z.infer<typeof allZodSchemas.GetPacka
 export type GetPackagesResponseDTO = z.infer<typeof allZodSchemas.GetPackagesResponse>
 export type PackageStatusDetailsDTO = z.infer<typeof allZodSchemas.PackageStatusDetails>
 export type GetPackageResponseDTO = z.infer<typeof allZodSchemas.GetPackageResponse>
+export type GetPackageByIdIncludesDTO = z.infer<typeof allZodSchemas.GetPackageByIdIncludes>
 export type GetPackageByIdResponseDTO = z.infer<typeof allZodSchemas.GetPackageByIdResponse>
 export type GetPackageByIdLatestResponseDTO = z.infer<typeof allZodSchemas.GetPackageByIdLatestResponse>
 export type GetPackageArchiveSignedUrlDTO = z.infer<typeof allZodSchemas.GetPackageArchiveSignedUrl>