@awarevue/api-types 2.0.21 → 2.0.23

package/dist/api/rest/person.d.ts

@@ -0,0 +1,128 @@
+import z from 'zod';
+export declare const sCreatePersonRequest: z.ZodObject<{
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    position: z.ZodNullable<z.ZodString>;
+    accessSuspended: z.ZodBoolean;
+    staffMember: z.ZodBoolean;
+    validFrom: z.ZodNullable<z.ZodString>;
+    validTo: z.ZodNullable<z.ZodString>;
+    avatarId: z.ZodNullable<z.ZodString>;
+    credentials: z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<["card", "pin", "fingerprint"]>;
+        value: z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
+        note: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "card" | "pin" | "fingerprint";
+        value: string | Record<string, unknown>;
+        note: string | null;
+    }, {
+        type: "card" | "pin" | "fingerprint";
+        value: string | Record<string, unknown>;
+        note: string | null;
+    }>, "many">;
+    accessRules: z.ZodArray<z.ZodString, "many">;
+    customFields: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>;
+    type: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    position: string | null;
+    firstName: string;
+    lastName: string;
+    avatarId: string | null;
+    accessSuspended: boolean;
+    staffMember: boolean;
+    validFrom: string | null;
+    validTo: string | null;
+    credentials: {
+        type: "card" | "pin" | "fingerprint";
+        value: string | Record<string, unknown>;
+        note: string | null;
+    }[];
+    accessRules: string[];
+    customFields: Record<string, string> | null;
+}, {
+    type: string;
+    position: string | null;
+    firstName: string;
+    lastName: string;
+    avatarId: string | null;
+    accessSuspended: boolean;
+    staffMember: boolean;
+    validFrom: string | null;
+    validTo: string | null;
+    credentials: {
+        type: "card" | "pin" | "fingerprint";
+        value: string | Record<string, unknown>;
+        note: string | null;
+    }[];
+    accessRules: string[];
+    customFields: Record<string, string> | null;
+}>;
+export declare const sUpdatePersonRequest: z.ZodObject<{
+    firstName: z.ZodOptional<z.ZodString>;
+    lastName: z.ZodOptional<z.ZodString>;
+    position: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    accessSuspended: z.ZodOptional<z.ZodBoolean>;
+    staffMember: z.ZodOptional<z.ZodBoolean>;
+    validFrom: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    validTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatarId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    credentials: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<["card", "pin", "fingerprint"]>;
+        value: z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
+        note: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "card" | "pin" | "fingerprint";
+        value: string | Record<string, unknown>;
+        note: string | null;
+    }, {
+        type: "card" | "pin" | "fingerprint";
+        value: string | Record<string, unknown>;
+        note: string | null;
+    }>, "many">>;
+    accessRules: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    customFields: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
+    type: z.ZodOptional<z.ZodString>;
+    archived: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    type?: string | undefined;
+    position?: string | null | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    avatarId?: string | null | undefined;
+    accessSuspended?: boolean | undefined;
+    staffMember?: boolean | undefined;
+    validFrom?: string | null | undefined;
+    validTo?: string | null | undefined;
+    credentials?: {
+        type: "card" | "pin" | "fingerprint";
+        value: string | Record<string, unknown>;
+        note: string | null;
+    }[] | undefined;
+    accessRules?: string[] | undefined;
+    customFields?: Record<string, string> | null | undefined;
+    archived?: boolean | undefined;
+}, {
+    type?: string | undefined;
+    position?: string | null | undefined;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    avatarId?: string | null | undefined;
+    accessSuspended?: boolean | undefined;
+    staffMember?: boolean | undefined;
+    validFrom?: string | null | undefined;
+    validTo?: string | null | undefined;
+    credentials?: {
+        type: "card" | "pin" | "fingerprint";
+        value: string | Record<string, unknown>;
+        note: string | null;
+    }[] | undefined;
+    accessRules?: string[] | undefined;
+    customFields?: Record<string, string> | null | undefined;
+    archived?: boolean | undefined;
+}>;
+export type CreatePersonRequest = z.infer<typeof sCreatePersonRequest>;
+export type UpdatePersonRequest = {
+    id: string;
+} & z.infer<typeof sUpdatePersonRequest>;

package/dist/api/rest/person.js

@@ -0,0 +1,8 @@
+import { sPersonProps } from '../../objects/person';
+import z from 'zod';
+export const sCreatePersonRequest = sPersonProps;
+export const sUpdatePersonRequest = sCreatePersonRequest
+    .extend({
+    archived: z.boolean(),
+})
+    .partial();

package/dist/api/{query.js → rest/query.js}

@@ -1,28 +1,23 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sPaginatedQueryResponseOf = exports.sPaginatedQueryRequestOf = void 0;
-const zod_1 = require("zod");
-const sPaginatedQueryRequestOf = (criteriaSchema) => zod_1.z
+import { z } from 'zod';
+export const sPaginatedQueryRequestOf = (criteriaSchema) => z
     .object({
-    q: zod_1.z.string().optional().describe('Not supported yet'),
-    offset: zod_1.z
+    q: z.string().optional().describe('Not supported yet'),
+    offset: z
         .number()
         .optional()
         .describe('Offset of the first item to return'),
-    limit: zod_1.z
+    limit: z
         .number()
         .optional()
         .describe('Maximum number of items to return'),
 })
     .merge(criteriaSchema.partial());
-exports.sPaginatedQueryRequestOf = sPaginatedQueryRequestOf;
-const sPaginatedQueryResponseOf = (itemSchema) => zod_1.z.object({
-    items: zod_1.z.array(itemSchema).describe('Array of items matching the query'),
-    total: zod_1.z
+export const sPaginatedQueryResponseOf = (itemSchema) => z.object({
+    items: z.array(itemSchema).describe('Array of items matching the query'),
+    total: z
         .number()
         .describe('Total number of items matching the query (only one page is shown at a time)'),
 });
-exports.sPaginatedQueryResponseOf = sPaginatedQueryResponseOf;
 // example usage:
 // import { sPaginatedQueryRequestOf, sPaginatedQueryResponseOf } from 'aware-api-types';
 // import { z } from 'zod';

package/dist/api/rest/schedule.d.ts

@@ -0,0 +1,249 @@
+import { z } from 'zod';
+export declare const sCreateScheduleRequest: z.ZodObject<{
+    displayName: z.ZodString;
+    flag: z.ZodNullable<z.ZodEnum<["always", "never"]>>;
+    include: z.ZodNullable<z.ZodObject<{
+        startDate: z.ZodNullable<z.ZodString>;
+        endDate: z.ZodNullable<z.ZodString>;
+        timeIntervals: z.ZodArray<z.ZodObject<{
+            weekDay: z.ZodEnum<["mon", "tue", "wed", "thu", "fri", "sat", "sun"]>;
+            from: z.ZodNumber;
+            to: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }, {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }>, "many">;
+        repeat: z.ZodNullable<z.ZodEnum<["daily", "weekly", "monthly", "yearly"]>>;
+    }, "strip", z.ZodTypeAny, {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    }, {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    }>>;
+    exclude: z.ZodNullable<z.ZodObject<{
+        startDate: z.ZodNullable<z.ZodString>;
+        endDate: z.ZodNullable<z.ZodString>;
+        timeIntervals: z.ZodArray<z.ZodObject<{
+            weekDay: z.ZodEnum<["mon", "tue", "wed", "thu", "fri", "sat", "sun"]>;
+            from: z.ZodNumber;
+            to: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }, {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }>, "many">;
+        repeat: z.ZodNullable<z.ZodEnum<["daily", "weekly", "monthly", "yearly"]>>;
+    }, "strip", z.ZodTypeAny, {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    }, {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    include: {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    } | null;
+    exclude: {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    } | null;
+    displayName: string;
+    flag: "always" | "never" | null;
+}, {
+    include: {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    } | null;
+    exclude: {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    } | null;
+    displayName: string;
+    flag: "always" | "never" | null;
+}>;
+export type CreateScheduleRequest = z.infer<typeof sCreateScheduleRequest>;
+export declare const sUpdateScheduleRequest: z.ZodObject<{
+    displayName: z.ZodOptional<z.ZodString>;
+    flag: z.ZodOptional<z.ZodNullable<z.ZodEnum<["always", "never"]>>>;
+    include: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        startDate: z.ZodNullable<z.ZodString>;
+        endDate: z.ZodNullable<z.ZodString>;
+        timeIntervals: z.ZodArray<z.ZodObject<{
+            weekDay: z.ZodEnum<["mon", "tue", "wed", "thu", "fri", "sat", "sun"]>;
+            from: z.ZodNumber;
+            to: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }, {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }>, "many">;
+        repeat: z.ZodNullable<z.ZodEnum<["daily", "weekly", "monthly", "yearly"]>>;
+    }, "strip", z.ZodTypeAny, {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    }, {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    }>>>;
+    exclude: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        startDate: z.ZodNullable<z.ZodString>;
+        endDate: z.ZodNullable<z.ZodString>;
+        timeIntervals: z.ZodArray<z.ZodObject<{
+            weekDay: z.ZodEnum<["mon", "tue", "wed", "thu", "fri", "sat", "sun"]>;
+            from: z.ZodNumber;
+            to: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }, {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }>, "many">;
+        repeat: z.ZodNullable<z.ZodEnum<["daily", "weekly", "monthly", "yearly"]>>;
+    }, "strip", z.ZodTypeAny, {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    }, {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    }>>>;
+}, "strip", z.ZodTypeAny, {
+    include?: {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    } | null | undefined;
+    exclude?: {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    } | null | undefined;
+    displayName?: string | undefined;
+    flag?: "always" | "never" | null | undefined;
+}, {
+    include?: {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    } | null | undefined;
+    exclude?: {
+        repeat: "daily" | "weekly" | "monthly" | "yearly" | null;
+        startDate: string | null;
+        endDate: string | null;
+        timeIntervals: {
+            weekDay: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
+            from: number;
+            to: number;
+        }[];
+    } | null | undefined;
+    displayName?: string | undefined;
+    flag?: "always" | "never" | null | undefined;
+}>;
+export type UpdateScheduleRequest = {
+    id: string;
+} & z.infer<typeof sUpdateScheduleRequest>;

package/dist/api/rest/schedule.js

@@ -0,0 +1,9 @@
+import { sFlagType, sScheduleDetailsRequest, sScheduleProps, } from '../../objects/schedule';
+import { z } from 'zod';
+export const sCreateScheduleRequest = sScheduleProps;
+export const sUpdateScheduleRequest = z.object({
+    displayName: z.string().optional(),
+    flag: sFlagType.nullable().optional(),
+    include: sScheduleDetailsRequest.nullable().optional(),
+    exclude: sScheduleDetailsRequest.nullable().optional(),
+});

package/dist/{security-level.d.ts → api/rest/security-level.d.ts}

@@ -1,32 +1,4 @@
 import { z } from 'zod';
-export declare const sSecurityLevelDto: z.ZodObject<{
-    id: z.ZodString;
-    order: z.ZodNumber;
-    name: z.ZodString;
-    active: z.ZodBoolean;
-    color: z.ZodString;
-    checkFrequency: z.ZodNumber;
-    checkOnExit: z.ZodBoolean;
-    default: z.ZodBoolean;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    default: boolean;
-    id: string;
-    active: boolean;
-    color: string;
-    order: number;
-    checkFrequency: number;
-    checkOnExit: boolean;
-}, {
-    name: string;
-    default: boolean;
-    id: string;
-    active: boolean;
-    color: string;
-    order: number;
-    checkFrequency: number;
-    checkOnExit: boolean;
-}>;
 export declare const sAddSecurityLevelRequest: z.ZodObject<Omit<{
     id: z.ZodString;
     order: z.ZodNumber;
@@ -78,6 +50,5 @@ export declare const sUpdateSecurityLevelRequest: z.ZodObject<{
     checkFrequency?: number | undefined;
     checkOnExit?: boolean | undefined;
 }>;
-export type SecurityLevelDto = z.infer<typeof sSecurityLevelDto>;
 export type AddSecurityLevelRequest = z.infer<typeof sAddSecurityLevelRequest>;
 export type UpdateSecurityLevelRequest = z.infer<typeof sUpdateSecurityLevelRequest>;

package/dist/api/rest/security-level.js

@@ -0,0 +1,5 @@
+import { sSecurityLevelDto } from '../../objects/security-level';
+export const sAddSecurityLevelRequest = sSecurityLevelDto.omit({
+    id: true,
+});
+export const sUpdateSecurityLevelRequest = sAddSecurityLevelRequest.partial();

package/dist/{template.d.ts → api/rest/template.d.ts}

@@ -1,5 +1,5 @@
+import { TemplateDto } from '../../objects/template';
 import { z } from 'zod';
-export declare const TemplateTypeEnum: z.ZodEnum<["id", "report"]>;
 export declare const sNewTemplateRequest: z.ZodObject<{
     name: z.ZodString;
     type: z.ZodEnum<["id", "report"]>;
@@ -26,25 +26,8 @@ export declare const sUpdateTemplateRequest: z.ZodObject<{
     type?: "id" | "report" | undefined;
     templateHtmlId?: string | undefined;
 }>;
-export declare const sTemplateDto: z.ZodObject<{
-    id: z.ZodString;
-    name: z.ZodString;
-    type: z.ZodEnum<["id", "report"]>;
-    templateHtmlId: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    type: "id" | "report";
-    id: string;
-    templateHtmlId: string;
-}, {
-    name: string;
-    type: "id" | "report";
-    id: string;
-    templateHtmlId: string;
-}>;
 export type NewTemplateRequest = z.infer<typeof sNewTemplateRequest>;
 export type UpdateTemplateRequest = z.infer<typeof sUpdateTemplateRequest>;
-export type TemplateDto = z.infer<typeof sTemplateDto>;
 export type TemplateRequestQueryParams = {
     type: TemplateDto['type'];
 };

package/dist/api/rest/template.js

@@ -0,0 +1,12 @@
+import { sTemplateTypeEnum } from '../../objects/template';
+import { z } from 'zod';
+export const sNewTemplateRequest = z.object({
+    name: z.string().min(1).max(64),
+    type: sTemplateTypeEnum,
+    templateHtmlId: z.string().uuid(),
+});
+export const sUpdateTemplateRequest = z.object({
+    name: z.string().min(1).max(64).optional(),
+    type: sTemplateTypeEnum.optional(),
+    templateHtmlId: z.string().uuid().optional(),
+});

package/dist/{token-conversion.d.ts → api/rest/token-conversion.d.ts}

@@ -1,25 +1,4 @@
 import { z } from 'zod';
-export declare const ConversionTypeEnum: z.ZodEnum<["hex-to-decimal"]>;
-export declare const sTokenConversionDto: z.ZodObject<{
-    id: z.ZodString;
-    name: z.ZodString;
-    type: z.ZodEnum<["hex-to-decimal"]>;
-    jsonData: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    type: "hex-to-decimal";
-    id: string;
-    jsonData: {} & {
-        [k: string]: unknown;
-    };
-}, {
-    name: string;
-    type: "hex-to-decimal";
-    id: string;
-    jsonData: {} & {
-        [k: string]: unknown;
-    };
-}>;
 export declare const sAddTokenConversionRequest: z.ZodObject<Omit<{
     id: z.ZodString;
     name: z.ZodString;
@@ -51,6 +30,5 @@ export declare const sUpdateTokenConversionRequest: z.ZodObject<{
     type?: "hex-to-decimal" | undefined;
     jsonData?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
 }>;
-export type TokenConversionDto = z.infer<typeof sTokenConversionDto>;
 export type AddTokenConversionRequest = z.infer<typeof sAddTokenConversionRequest>;
 export type UpdateTokenConversionRequest = z.infer<typeof sUpdateTokenConversionRequest>;

package/dist/api/rest/token-conversion.js

@@ -0,0 +1,5 @@
+import { sTokenConversionDto } from '../../objects/token-conversion';
+export const sAddTokenConversionRequest = sTokenConversionDto.omit({
+    id: true,
+});
+export const sUpdateTokenConversionRequest = sAddTokenConversionRequest.partial();