@abcagency/hire-control-sdk 1.1.1 → 1.1.3

package/index.ts

@@ -50,7 +50,10 @@ import Event, {
 import { Listing } from "./types/listing";
 import Filters from "./types/filters/filters";
 import AppendListing from "./types/appendListing";
-import Form, { FormFieldMigrationRequest, FormUpdateOptions } from "./types/form";
+import Form, {
+  FormFieldMigrationRequest,
+  FormUpdateOptions,
+} from "./types/form";
 import FormSubmission, { FormSubmissionStatus } from "./types/formSubmission";
 import ResultsWrapper from "./types/resultsWrapper";
 import { JobListing } from "./types/JobListing";
@@ -69,8 +72,16 @@ import ContentModel, {
 } from "./types/content/model";
 import ContentBlock from "./types/content/block";
 import ContentEntry from "./types/content/contentEntry";
+import {
+  BlockUpdateImpact,
+  BlockFieldChange,
+  BlockFieldMigration,
+} from "./types/content/blockUpdateImpact";
 import Blog from "./types/blog";
-import CategoryListDto, { AddValueRequest } from "./types/categoryList";
+import CategoryListDto, {
+  AddValueRequest,
+  CategoryListValueDto,
+} from "./types/categoryList";
 import JobFeed from "./types/jobFeed";
 import JobFeedFieldMapping, {
   MultipleFieldConfig,
@@ -83,10 +94,18 @@ import JobListingSettings, {
 import ListingEntityDto from "./types/listingEntity";
 import RecruiterDto from "./types/recruiter";
 import FocalPoint from "./types/focalPoint";
+import ListingEntityMedia from "./types/listingEntityMedia";
 import CompletionRequest, {
   CompletionResponse,
 } from "./types/completionRequest";
 import SearchReadConfig from "./types/searchReadConfig";
+import {
+  BLOCK_KEYS,
+  BLOCK_KEY_ALIASES,
+  FIELD_TYPES,
+  type BlockKey,
+  type FieldType,
+} from "./constants/cms";
 
 export const auth = {
   login: authController.login,
@@ -193,6 +212,7 @@ export const categoryLists = {
   delete: categoryListsController.deleteCategoryList,
   addValue: categoryListsController.addValue,
   removeValue: categoryListsController.removeValue,
+  updateValue: categoryListsController.updateValue,
   updateValues: categoryListsController.updateValues,
 };
 
@@ -255,6 +275,9 @@ export const jobListings = {
   getMapListings: JobListingsController.getMapJobListingsByCompany,
   getMapListing: JobListingsController.getMapListingById,
   getById: JobListingsController.getJobListingById,
+  updateFieldVersionApproval: JobListingsController.updateFieldVersionApproval,
+  updateDescriptionVersionApproval:
+    JobListingsController.updateDescriptionVersionApproval,
   create: JobListingsController.createJobListing,
   update: JobListingsController.updateJobListing,
   delete: JobListingsController.deleteJobListing,
@@ -271,6 +294,7 @@ export const contentValidator = {
 export const contentEntries = {
   getAll: contentEntriesController.getContentEntries,
   getById: contentEntriesController.getContentEntry,
+  getBySlug: contentEntriesController.getContentEntryBySlug,
   create: contentEntriesController.createContentEntry,
   update: contentEntriesController.updateContentEntry,
   delete: contentEntriesController.deleteContentEntry,
@@ -282,6 +306,8 @@ export const contentBlocks = {
   getById: blocksController.getBlock,
   create: blocksController.createBlock,
   update: blocksController.updateBlock,
+  updateWithMigrations: blocksController.updateBlockWithMigrations,
+  previewUpdate: blocksController.previewBlockUpdate,
   delete: blocksController.deleteBlock,
   getTemplateBlocks: blocksController.getTemplateBlocks,
 };
@@ -302,6 +328,7 @@ export const openAI = {
 
 export const forms = formsController;
 export const formSubmissions = formSubmissionController;
+export { BLOCK_KEYS, BLOCK_KEY_ALIASES, FIELD_TYPES };
 //types
 export type {
   Register,
@@ -337,10 +364,14 @@ export type {
   ContentModuleSyncExecuteRequest,
   ContentModuleSyncExecuteResult,
   ContentBlock,
+  BlockUpdateImpact,
+  BlockFieldChange,
+  BlockFieldMigration,
   ContentEntry,
   Blog,
   CategoryListDto,
   AddValueRequest,
+  CategoryListValueDto,
   JobFeed,
   JobFeedFieldMapping,
   MultipleFieldConfig,
@@ -350,10 +381,12 @@ export type {
   ListingEntityDto,
   RecruiterDto,
   FocalPoint,
+  ListingEntityMedia,
   CompletionRequest,
   CompletionResponse,
   SearchReadConfig,
 };
+export type { BlockKey, FieldType };
 
 export {
   EventType,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abcagency/hire-control-sdk",
-  "version": "1.1.01",
+  "version": "1.1.3",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
@@ -28,6 +28,7 @@
     "rollup-plugin-typescript2": "^0.36.0"
   },
   "dependencies": {
+    "@abcagency/hire-control-sdk": "^1.1.2",
     "tslib": "^2.7.0",
     "typescript": "^5.6.2"
   }

package/types/JobListing.ts

@@ -74,6 +74,7 @@ export type FieldVersion = {
   source: string | null;
   user: string | null;
   needsApproval: boolean;
+  listingVersionNumber?: number;
 };
 
 export type AuditTrailEntry = {

package/types/categoryList.ts

@@ -5,13 +5,18 @@ export type ModifiedByDto = {
   dateTime: string;
 };
 
+export type CategoryListValueDto = {
+  displayValue: string;
+  displayInForms: boolean;
+};
+
 export type CategoryListDto = {
   id: string;
   companyId: string;
   type: string;
   name: string;
   description?: string;
-  values: Record<string, string>;
+  values: Record<string, CategoryListValueDto>;
   isActive: boolean;
   autoAddNewValues: boolean;
   notifyOnNewValues: boolean;
@@ -23,7 +28,8 @@ export type CategoryListDto = {
 
 export type AddValueRequest = {
   key: string;
-  value: string;
+  displayValue: string;
+  displayInForms: boolean;
 };
 
 export default CategoryListDto;

package/types/content/blockUpdateImpact.ts

@@ -0,0 +1,24 @@
+export type BlockFieldChange = {
+  oldKey?: string;
+  newKey?: string;
+  key?: string;
+  affectedEntryCount?: number;
+};
+
+export type BlockUpdateImpact = {
+  renamedFields?: BlockFieldChange[];
+  removedFields?: BlockFieldChange[];
+  addedFields?: BlockFieldChange[];
+  affectedEntries?: Array<{
+    usedIn?: string;
+    title?: string;
+  }>;
+};
+
+export type BlockFieldMigration = {
+  type: "rename" | "remove";
+  oldKey?: string;
+  newKey?: string;
+  key?: string;
+  cleanup?: boolean;
+};

package/types/content/model.ts

@@ -15,6 +15,34 @@ export type ModuleFieldMapping = {
   applyOnSync?: boolean;
 };
 
+export type ModuleGrouping = {
+  enabled?: boolean;
+  groupBySourcePath?: string;
+  displayNameSourcePath?: string;
+  sourceKeyPrefix?: string;
+  includeUngrouped?: boolean;
+};
+
+export type ModuleSectionRepeaterFieldMapping = {
+  targetField?: string;
+  sourcePath?: string;
+  slugifyValue?: boolean;
+  buildUrlPath?: boolean;
+  urlPathBase?: string;
+};
+
+export type ModuleSectionRepeater = {
+  id?: string;
+  sectionId?: string;
+  sectionIndex?: number;
+  blockKey?: string;
+  sourceCollectionPath?: string;
+  itemIdentitySourcePath?: string;
+  applyOnSync?: boolean;
+  syncOnRead?: boolean;
+  fieldMappings?: ModuleSectionRepeaterFieldMapping[];
+};
+
 export type ModuleSourceFilter = {
   combinator?: "and" | "or" | string;
   rules?: Array<any>;
@@ -32,6 +60,10 @@ export type WebPageTemplateSection = {
   title?: string;
   slug?: string;
   showInNav?: boolean;
+  layout?: Record<string, any>;
+  items?: Array<Record<string, any>>;
+  collapsed?: boolean;
+  order?: number;
   blocks?: WebPageTemplateBlock[];
 };
 
@@ -43,8 +75,11 @@ export type ModuleConfig = {
   sourceType?: "listingEntities" | "jobListings" | "categoryLists" | string;
   autoSetupEntries?: boolean;
   identityMapping?: ModuleIdentityMapping;
+  slugPrefixSourcePath?: string;
   fieldMappings?: ModuleFieldMapping[];
   sourceFilter?: ModuleSourceFilter;
+  grouping?: ModuleGrouping;
+  sectionRepeaters?: ModuleSectionRepeater[];
   webPageTemplate?: WebPageTemplate;
 };
 

package/types/hireControlConfig.ts

@@ -76,9 +76,25 @@ export interface CmsNavigationNode {
   isExternal?: boolean;
   isButton?: boolean;
   showInNav?: boolean;
+  autoPopulate?: CmsNavigationAutoPopulate;
   children?: CmsNavigationNode[];
 }
 
+export interface CmsNavigationAutoPopulate {
+  enabled?: boolean;
+  modelIds?: string[];
+  maxItems?: number;
+  matchParentSlugPrefix?: boolean;
+  childAutoPopulate?: CmsNavigationAutoPopulateRule;
+}
+
+export interface CmsNavigationAutoPopulateRule {
+  enabled?: boolean;
+  modelIds?: string[];
+  maxItems?: number;
+  matchParentSlugPrefix?: boolean;
+}
+
 export interface CmsNavigationConfig {
   version?: number;
   maxDepth?: number;

package/types/listing.ts

@@ -1,3 +1,5 @@
+import ListingEntityMedia from "./listingEntityMedia";
+
 export type Listing = {
   id: number;
   fields?: ListingFields;
@@ -79,6 +81,8 @@ export type ListingEntity = {
   travelTime?: string;
   logoUrl?: string;
   photoUrl?: string;
+  logo?: ListingEntityMedia;
+  photo?: ListingEntityMedia;
   descriptionJson?: string;
   descriptionHtml?: string;
   descriptionPlainText?: string;

package/types/listingEntity.ts

@@ -1,4 +1,5 @@
 import { Address } from './company';
+import ListingEntityMedia from './listingEntityMedia';
 
 export type ListingEntityDto = {
   id: number;
@@ -12,6 +13,8 @@ export type ListingEntityDto = {
   staticMapUrl?: string;
   logoUrl?: string;
   photoUrl?: string;
+  logo?: ListingEntityMedia;
+  photo?: ListingEntityMedia;
   descriptionJson?: string;
   descriptionHtml?: string;
   descriptionPlainText?: string;

package/types/listingEntityMedia.ts

@@ -0,0 +1,14 @@
+import FocalPoint from "./focalPoint";
+
+export type ListingEntityMedia = {
+  url?: string;
+  alt?: string;
+  focalPoint?: FocalPoint;
+  aspectRatio?: string;
+  width?: number;
+  height?: number;
+  fileSize?: number;
+  variant?: string;
+};
+
+export default ListingEntityMedia;

package/types/mongoListingEntity.ts

@@ -1,4 +1,5 @@
 import { Address } from "./company";
+import ListingEntityMedia from "./listingEntityMedia";
 
 export type mongoListingEntity = {
   id: string;
@@ -13,6 +14,8 @@ export type mongoListingEntity = {
   entityKey?: string;
   logoUrl?: string;
   photoUrl?: string;
+  logo?: ListingEntityMedia;
+  photo?: ListingEntityMedia;
   descriptionJson?: string;
   descriptionHtml?: string;
   descriptionPlainText?: string;