@aibrains/shared-types 0.1.0

package/dist/schemas/identity/credential.schema.js

@@ -0,0 +1,200 @@
+"use strict";
+/**
+ * Credential Schemas - Identity Service
+ *
+ * Zod schemas for staff credential management with Ed-Fi alignment.
+ * Ed-Fi: Credential represents teaching licenses, certifications, endorsements.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.credentialExpirationAlertSchema = exports.verifyCredentialSchema = exports.credentialFilterSchema = exports.credentialListResponseSchema = exports.credentialResponseSchema = exports.updateCredentialSchema = exports.createCredentialSchema = exports.gradeLevelDescriptorSchema = exports.verificationStatusSchema = exports.credentialFieldSchema = exports.credentialTypeSchema = void 0;
+const zod_1 = require("zod");
+const common_1 = require("../common");
+// ============================================
+// Enums (Ed-Fi aligned)
+// ============================================
+/**
+ * Credential type (Ed-Fi: credentialTypeDescriptor)
+ */
+exports.credentialTypeSchema = zod_1.z.enum([
+    'certification', // Teaching certification
+    'license', // Professional license
+    'endorsement', // Subject/grade endorsement
+    'degree', // Academic degree
+    'registration', // Professional registration
+    'permit', // Work permit
+    'clearance', // Background clearance
+    'training', // Training completion
+    'other',
+]);
+/**
+ * Credential field/subject area (Ed-Fi: credentialFieldDescriptor)
+ */
+exports.credentialFieldSchema = zod_1.z.enum([
+    'elementary_education',
+    'secondary_education',
+    'special_education',
+    'early_childhood',
+    'mathematics',
+    'science',
+    'english_language_arts',
+    'social_studies',
+    'foreign_language',
+    'physical_education',
+    'music',
+    'art',
+    'technology',
+    'counseling',
+    'administration',
+    'library_media',
+    'other',
+]);
+/**
+ * Verification status
+ */
+exports.verificationStatusSchema = zod_1.z.enum([
+    'pending',
+    'verified',
+    'rejected',
+    'expired',
+    'revoked',
+]);
+/**
+ * Grade level (Ed-Fi aligned)
+ */
+exports.gradeLevelDescriptorSchema = zod_1.z.enum([
+    'pre_k',
+    'kindergarten',
+    'first',
+    'second',
+    'third',
+    'fourth',
+    'fifth',
+    'sixth',
+    'seventh',
+    'eighth',
+    'ninth',
+    'tenth',
+    'eleventh',
+    'twelfth',
+    'adult_education',
+    'ungraded',
+]);
+// ============================================
+// Create Credential Schema
+// ============================================
+exports.createCredentialSchema = zod_1.z.object({
+    // Ed-Fi Core Fields
+    credentialIdentifier: zod_1.z.string().min(1).max(60), // Ed-Fi: credentialIdentifier
+    credentialTypeDescriptor: exports.credentialTypeSchema, // Ed-Fi: credentialTypeDescriptor
+    credentialFieldDescriptor: exports.credentialFieldSchema.optional(), // Ed-Fi: credentialFieldDescriptor
+    issuanceDate: common_1.dateSchema, // Ed-Fi: issuanceDate
+    expirationDate: common_1.dateSchema.optional(), // Ed-Fi: expirationDate
+    // Issuing Authority (Ed-Fi: stateOfIssueStateAbbreviationDescriptor)
+    issuingState: zod_1.z.string().max(50).optional(),
+    issuingOrganization: zod_1.z.string().max(150),
+    // Grade Levels (Ed-Fi: credentialGradeLevels)
+    gradeLevels: zod_1.z.array(exports.gradeLevelDescriptorSchema).optional(),
+    // Academic Subjects (simplified)
+    subjects: zod_1.z.array(zod_1.z.string().max(60)).optional(),
+    // EdForge Extensions
+    name: zod_1.z.string().min(1).max(150), // Human-readable name
+    description: zod_1.z.string().max(500).optional(),
+    documentUrl: zod_1.z.string().url().optional(), // Link to scanned document
+    documentFileName: zod_1.z.string().max(255).optional(),
+    // Verification
+    verificationStatus: exports.verificationStatusSchema.default('pending'),
+    verificationNotes: zod_1.z.string().max(500).optional(),
+    verifiedBy: zod_1.z.string().uuid().optional(),
+    verifiedAt: common_1.isoDateSchema.optional(),
+    // Renewal tracking
+    isRenewable: zod_1.z.boolean().default(true),
+    renewalReminderDays: zod_1.z.number().int().min(0).max(365).default(90),
+});
+// ============================================
+// Update Credential Schema
+// ============================================
+exports.updateCredentialSchema = exports.createCredentialSchema.partial().omit({
+    credentialIdentifier: true, // Cannot change identifier
+}).extend({
+    verificationStatus: exports.verificationStatusSchema.optional(),
+});
+// ============================================
+// Credential Response Schema
+// ============================================
+exports.credentialResponseSchema = zod_1.z.object({
+    // Identifiers
+    credentialId: zod_1.z.string().uuid(),
+    staffId: zod_1.z.string().uuid(),
+    tenantId: zod_1.z.string().uuid(),
+    // Ed-Fi Core
+    credentialIdentifier: zod_1.z.string(),
+    credentialTypeDescriptor: exports.credentialTypeSchema,
+    credentialFieldDescriptor: exports.credentialFieldSchema.optional(),
+    issuanceDate: zod_1.z.string(),
+    expirationDate: zod_1.z.string().optional(),
+    // Issuing Authority
+    issuingState: zod_1.z.string().optional(),
+    issuingOrganization: zod_1.z.string(),
+    // Grade Levels & Subjects
+    gradeLevels: zod_1.z.array(exports.gradeLevelDescriptorSchema).optional(),
+    subjects: zod_1.z.array(zod_1.z.string()).optional(),
+    // EdForge Extensions
+    name: zod_1.z.string(),
+    description: zod_1.z.string().optional(),
+    documentUrl: zod_1.z.string().optional(),
+    documentFileName: zod_1.z.string().optional(),
+    // Verification
+    verificationStatus: exports.verificationStatusSchema,
+    verificationNotes: zod_1.z.string().optional(),
+    verifiedBy: zod_1.z.string().optional(),
+    verifiedByName: zod_1.z.string().optional(),
+    verifiedAt: zod_1.z.string().optional(),
+    // Renewal
+    isRenewable: zod_1.z.boolean(),
+    renewalReminderDays: zod_1.z.number(),
+    // Computed
+    isExpired: zod_1.z.boolean(),
+    daysUntilExpiration: zod_1.z.number().optional(),
+    isExpiringSoon: zod_1.z.boolean(), // Within renewal reminder period
+    // Metadata
+    createdAt: zod_1.z.string(),
+    updatedAt: zod_1.z.string(),
+});
+// ============================================
+// Credential List Response
+// ============================================
+exports.credentialListResponseSchema = (0, common_1.createPaginatedResponseSchema)(exports.credentialResponseSchema);
+// ============================================
+// Credential Filter Schema
+// ============================================
+exports.credentialFilterSchema = zod_1.z.object({
+    staffId: zod_1.z.string().uuid().optional(),
+    credentialType: exports.credentialTypeSchema.optional(),
+    credentialField: exports.credentialFieldSchema.optional(),
+    verificationStatus: exports.verificationStatusSchema.optional(),
+    isExpired: zod_1.z.boolean().optional(),
+    isExpiringSoon: zod_1.z.boolean().optional(),
+    limit: zod_1.z.coerce.number().min(1).max(100).default(20),
+    cursor: zod_1.z.string().optional(),
+});
+// ============================================
+// Verify Credential Schema
+// ============================================
+exports.verifyCredentialSchema = zod_1.z.object({
+    verificationStatus: zod_1.z.enum(['verified', 'rejected']),
+    verificationNotes: zod_1.z.string().max(500).optional(),
+});
+// ============================================
+// Credential Expiration Alert
+// ============================================
+exports.credentialExpirationAlertSchema = zod_1.z.object({
+    credentialId: zod_1.z.string().uuid(),
+    staffId: zod_1.z.string().uuid(),
+    staffName: zod_1.z.string(),
+    credentialName: zod_1.z.string(),
+    expirationDate: zod_1.z.string(),
+    daysUntilExpiration: zod_1.z.number(),
+    schoolId: zod_1.z.string().uuid(),
+    schoolName: zod_1.z.string(),
+});
+//# sourceMappingURL=credential.schema.js.map

package/dist/schemas/identity/credential.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credential.schema.js","sourceRoot":"","sources":["../../../src/schemas/identity/credential.schema.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,6BAAwB;AACxB,sCAImB;AAEnB,+CAA+C;AAC/C,wBAAwB;AACxB,+CAA+C;AAE/C;;GAEG;AACU,QAAA,oBAAoB,GAAG,OAAC,CAAC,IAAI,CAAC;IACzC,eAAe,EAAU,yBAAyB;IAClD,SAAS,EAAgB,uBAAuB;IAChD,aAAa,EAAY,4BAA4B;IACrD,QAAQ,EAAiB,kBAAkB;IAC3C,cAAc,EAAW,4BAA4B;IACrD,QAAQ,EAAiB,cAAc;IACvC,WAAW,EAAc,uBAAuB;IAChD,UAAU,EAAe,sBAAsB;IAC/C,OAAO;CACR,CAAC,CAAC;AAGH;;GAEG;AACU,QAAA,qBAAqB,GAAG,OAAC,CAAC,IAAI,CAAC;IAC1C,sBAAsB;IACtB,qBAAqB;IACrB,mBAAmB;IACnB,iBAAiB;IACjB,aAAa;IACb,SAAS;IACT,uBAAuB;IACvB,gBAAgB;IAChB,kBAAkB;IAClB,oBAAoB;IACpB,OAAO;IACP,KAAK;IACL,YAAY;IACZ,YAAY;IACZ,gBAAgB;IAChB,eAAe;IACf,OAAO;CACR,CAAC,CAAC;AAGH;;GAEG;AACU,QAAA,wBAAwB,GAAG,OAAC,CAAC,IAAI,CAAC;IAC7C,SAAS;IACT,UAAU;IACV,UAAU;IACV,SAAS;IACT,SAAS;CACV,CAAC,CAAC;AAGH;;GAEG;AACU,QAAA,0BAA0B,GAAG,OAAC,CAAC,IAAI,CAAC;IAC/C,OAAO;IACP,cAAc;IACd,OAAO;IACP,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,OAAO;IACP,OAAO;IACP,SAAS;IACT,QAAQ;IACR,OAAO;IACP,OAAO;IACP,UAAU;IACV,SAAS;IACT,iBAAiB;IACjB,UAAU;CACX,CAAC,CAAC;AAGH,+CAA+C;AAC/C,2BAA2B;AAC3B,+CAA+C;AAElC,QAAA,sBAAsB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC7C,oBAAoB;IACpB,oBAAoB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAM,8BAA8B;IACnF,wBAAwB,EAAE,4BAAoB,EAAQ,kCAAkC;IACxF,yBAAyB,EAAE,6BAAqB,CAAC,QAAQ,EAAE,EAAE,mCAAmC;IAChG,YAAY,EAAE,mBAAU,EAA8B,sBAAsB;IAC5E,cAAc,EAAE,mBAAU,CAAC,QAAQ,EAAE,EAAiB,wBAAwB;IAE9E,qEAAqE;IACrE,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,mBAAmB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAExC,8CAA8C;IAC9C,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,kCAA0B,CAAC,CAAC,QAAQ,EAAE;IAE3D,iCAAiC;IACjC,QAAQ,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAEhD,qBAAqB;IACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAqB,sBAAsB;IAC3E,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IAC3C,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAa,2BAA2B;IAChF,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IAEhD,eAAe;IACf,kBAAkB,EAAE,gCAAwB,CAAC,OAAO,CAAC,SAAS,CAAC;IAC/D,iBAAiB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IACjD,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACxC,UAAU,EAAE,sBAAa,CAAC,QAAQ,EAAE;IAEpC,mBAAmB;IACnB,WAAW,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IACtC,mBAAmB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CAClE,CAAC,CAAC;AAIH,+CAA+C;AAC/C,2BAA2B;AAC3B,+CAA+C;AAElC,QAAA,sBAAsB,GAAG,8BAAsB,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC;IAC1E,oBAAoB,EAAE,IAAI,EAAG,2BAA2B;CACzD,CAAC,CAAC,MAAM,CAAC;IACR,kBAAkB,EAAE,gCAAwB,CAAC,QAAQ,EAAE;CACxD,CAAC,CAAC;AAIH,+CAA+C;AAC/C,6BAA6B;AAC7B,+CAA+C;AAElC,QAAA,wBAAwB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC/C,cAAc;IACd,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC/B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC1B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAE3B,aAAa;IACb,oBAAoB,EAAE,OAAC,CAAC,MAAM,EAAE;IAChC,wBAAwB,EAAE,4BAAoB;IAC9C,yBAAyB,EAAE,6BAAqB,CAAC,QAAQ,EAAE;IAC3D,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;IACxB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAErC,oBAAoB;IACpB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,mBAAmB,EAAE,OAAC,CAAC,MAAM,EAAE;IAE/B,0BAA0B;IAC1B,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,kCAA0B,CAAC,CAAC,QAAQ,EAAE;IAC3D,QAAQ,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAExC,qBAAqB;IACrB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEvC,eAAe;IACf,kBAAkB,EAAE,gCAAwB;IAC5C,iBAAiB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEjC,UAAU;IACV,WAAW,EAAE,OAAC,CAAC,OAAO,EAAE;IACxB,mBAAmB,EAAE,OAAC,CAAC,MAAM,EAAE;IAE/B,WAAW;IACX,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE;IACtB,mBAAmB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,cAAc,EAAE,OAAC,CAAC,OAAO,EAAE,EAAG,iCAAiC;IAE/D,WAAW;IACX,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;CACtB,CAAC,CAAC;AAIH,+CAA+C;AAC/C,2BAA2B;AAC3B,+CAA+C;AAElC,QAAA,4BAA4B,GAAG,IAAA,sCAA6B,EAAC,gCAAwB,CAAC,CAAC;AAGpG,+CAA+C;AAC/C,2BAA2B;AAC3B,+CAA+C;AAElC,QAAA,sBAAsB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC7C,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACrC,cAAc,EAAE,4BAAoB,CAAC,QAAQ,EAAE;IAC/C,eAAe,EAAE,6BAAqB,CAAC,QAAQ,EAAE;IACjD,kBAAkB,EAAE,gCAAwB,CAAC,QAAQ,EAAE;IACvD,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACjC,cAAc,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACtC,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACpD,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAC;AAIH,+CAA+C;AAC/C,2BAA2B;AAC3B,+CAA+C;AAElC,QAAA,sBAAsB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC7C,kBAAkB,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACpD,iBAAiB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;CAClD,CAAC,CAAC;AAIH,+CAA+C;AAC/C,8BAA8B;AAC9B,+CAA+C;AAElC,QAAA,+BAA+B,GAAG,OAAC,CAAC,MAAM,CAAC;IACtD,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC/B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC1B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;IACrB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;IAC1B,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;IAC1B,mBAAmB,EAAE,OAAC,CAAC,MAAM,EAAE;IAC/B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC3B,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;CACvB,CAAC,CAAC"}