@abcagency/hire-control-sdk 1.1.1 → 1.1.3

package/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

package/constants/cms.ts

@@ -0,0 +1,60 @@
+export const BLOCK_KEYS = {
+  HERO: "hero",
+  VIDEO_BLOCK: "videoBlock",
+  CONTENT_CARD: "contentCard",
+  ICON_CARD: "iconCard",
+  LIST: "list",
+  CONTAINER: "container",
+  ACCORDION: "accordion",
+  TESTIMONIAL: "testimonial",
+  LARGE_TITLE_BLOCK: "largeTitleBlock",
+  BUTTON: "button",
+  RECRUITER: "recruiter",
+  BLOBS: "blobs",
+  TITLE_MODULAR_CONTENT_COPY: "titleModularContentCopy",
+  INTRO_WITH_CONTENT_CARD: "introWithContentCard",
+  CALLOUT_CARD: "calloutCard",
+} as const;
+
+export const BLOCK_KEY_ALIASES: Record<string, string> = {
+  "testimonial-block": BLOCK_KEYS.TESTIMONIAL,
+  "button-block": BLOCK_KEYS.BUTTON,
+  "recruiter-block": BLOCK_KEYS.RECRUITER,
+};
+
+export const FIELD_TYPES = {
+  SINGLE_LINE_STRING: "SingleLineString",
+  MULTI_LINE_TEXT: "MultiLineText",
+  MULTIPLE_PARAGRAPH_TEXT: "MultipleParagraphText",
+  SLUG: "Slug",
+  STRUCTURED_TEXT: "StructuredText",
+  RICH_TEXT: "RichText",
+  INTEGER_NUMBER: "IntegerNumber",
+  FLOATING_POINT_NUMBER: "FloatingPointNumber",
+  BOOLEAN: "Boolean",
+  DATE: "Date",
+  DATE_TIME: "DateTime",
+  SINGLE_MEDIA: "SingleMedia",
+  MEDIA_GALLERY: "MediaGallery",
+  EXTERNAL_VIDEO: "ExternalVideo",
+  COLOR: "Color",
+  TAILWIND_COLOR_SELECTOR: "TailwindColorSelector",
+  SINGLE_LINK: "SingleLink",
+  MULTIPLE_LINKS: "MultipleLinks",
+  LOCATION: "Location",
+  JSON: "Json",
+  SEO: "Seo",
+  MODULAR_CONTENT: "ModularContent",
+  SINGLE_BLOCK: "SingleBlock",
+  JOB_FILTER: "JobFilter",
+  FORM: "Form",
+  SINGLE_CONTENT_REFERENCE: "SingleContentReference",
+  MULTIPLE_CONTENT_REFERENCE: "MultipleContentReference",
+  HIRE_CONTROL_MAP: "HireControlMap",
+  RECRUITER_SELECTOR: "RecruiterSelector",
+  TAGS: "Tags",
+  VARIANT_SELECTOR: "VariantSelector",
+} as const;
+
+export type BlockKey = (typeof BLOCK_KEYS)[keyof typeof BLOCK_KEYS];
+export type FieldType = (typeof FIELD_TYPES)[keyof typeof FIELD_TYPES];

package/controllers/categoryListsController.ts

@@ -1,6 +1,9 @@
 import FetchHandler from "../handlers/fetchHandler";
 import { API_URL } from "../constants/config";
-import CategoryListDto, { AddValueRequest } from "../types/categoryList";
+import CategoryListDto, {
+  AddValueRequest,
+  CategoryListValueDto,
+} from "../types/categoryList";
 
 const fetchHandler = new FetchHandler(API_URL);
 
@@ -181,22 +184,44 @@ class CategoryListsController {
   /**
    * Update values in a category list.
    * @param {string} id - The category list ID.
-   * @param {Record<string, string>} values - The values to update.
+   * @param {Record<string, CategoryListDto["values"][string]>} values - The values to update.
    * @param {string | null} authToken - Optional auth token.
    * @returns {Promise<CategoryListDto>} - The updated category list data.
    */
   async updateValues(
     id: string,
-    values: Record<string, string>,
+    values: Record<string, CategoryListDto["values"][string]>,
     authToken: string | null = null
   ): Promise<CategoryListDto> {
-    return fetchHandler.put<Record<string, string>, CategoryListDto>(
+    return fetchHandler.put<Record<string, CategoryListDto["values"][string]>, CategoryListDto>(
       `/categorylist/${id}/values`,
       values,
       true,
       authToken
     );
   }
+
+  /**
+   * Update a single value in a category list.
+   * @param {string} id - The category list ID.
+   * @param {string} key - The value key to update.
+   * @param {CategoryListValueDto} value - The value payload.
+   * @param {string | null} authToken - Optional auth token.
+   * @returns {Promise<CategoryListDto>} - The updated category list data.
+   */
+  async updateValue(
+    id: string,
+    key: string,
+    value: CategoryListValueDto,
+    authToken: string | null = null
+  ): Promise<CategoryListDto> {
+    return fetchHandler.put<CategoryListValueDto, CategoryListDto>(
+      `/categorylist/${id}/values/${encodeURIComponent(key)}`,
+      value,
+      true,
+      authToken
+    );
+  }
 }
 
 export default new CategoryListsController();

package/controllers/content/blocksController.ts

@@ -1,5 +1,10 @@
 import FetchHandler from "../../handlers/fetchHandler";
+import { normalizeToCamelCase } from "../../handlers/normalize-casing";
 import Block from "../../types/content/block";
+import {
+  BlockUpdateImpact,
+  BlockFieldMigration,
+} from "../../types/content/blockUpdateImpact";
 import { API_URL } from "../../constants/config";
 
 const fetchHandler = new FetchHandler(API_URL);
@@ -11,7 +16,8 @@ class BlocksController {
    * @returns {Promise<Block[]>} - A list of blocks.
    */
   async getBlocks(authToken: string | null = null): Promise<Block[]> {
-    return fetchHandler.get<Block[]>("/block", true, authToken);
+    const response = await fetchHandler.get<Block[]>("/block", true, authToken);
+    return normalizeToCamelCase(response);
   }
 
   /**
@@ -21,7 +27,8 @@ class BlocksController {
    * @returns {Promise<Block>} - The block data.
    */
   async getBlock(id: string, authToken: string | null = null): Promise<Block> {
-    return fetchHandler.get<Block>(`/block/${id}`, true, authToken);
+    const response = await fetchHandler.get<Block>(`/block/${id}`, true, authToken);
+    return normalizeToCamelCase(response);
   }
 
   /**
@@ -34,7 +41,13 @@ class BlocksController {
     block: Block,
     authToken: string | null = null
   ): Promise<Block> {
-    return fetchHandler.post<Block, Block>("/block", block, true, authToken);
+    const response = await fetchHandler.post<Block, Block>(
+      "/block",
+      block,
+      true,
+      authToken
+    );
+    return normalizeToCamelCase(response);
   }
 
   /**
@@ -57,6 +70,46 @@ class BlocksController {
     );
   }
 
+  /**
+   * Update an existing block and apply optional field migrations.
+   * Backward compatible with the legacy PUT body.
+   */
+  async updateBlockWithMigrations(
+    id: string,
+    block: Block,
+    fieldMigrations: BlockFieldMigration[] = [],
+    authToken: string | null = null
+  ): Promise<void> {
+    const payload =
+      fieldMigrations.length > 0
+        ? { block, fieldMigrations }
+        : block;
+
+    return fetchHandler.put<typeof payload, void>(
+      `/block/${id}`,
+      payload,
+      true,
+      authToken
+    );
+  }
+
+  /**
+   * Preview the impact of updating a block definition before saving it.
+   */
+  async previewBlockUpdate(
+    id: string,
+    block: Block,
+    authToken: string | null = null
+  ): Promise<BlockUpdateImpact> {
+    const response = await fetchHandler.post<Block, BlockUpdateImpact>(
+      `/block/${id}/preview-update`,
+      block,
+      true,
+      authToken
+    );
+    return normalizeToCamelCase(response);
+  }
+
   /**
    * Delete an existing block.
    * @param {string} id - The block ID to delete.
@@ -76,7 +129,12 @@ class BlocksController {
    * @returns {Promise<Block[]>} - A list of template blocks.
    */
   async getTemplateBlocks(authToken: string | null = null): Promise<Block[]> {
-    return fetchHandler.get<Block[]>("/block/template-blocks", true, authToken);
+    const response = await fetchHandler.get<Block[]>(
+      "/block/template-blocks",
+      true,
+      authToken
+    );
+    return normalizeToCamelCase(response);
   }
 }
 

package/controllers/content/contentEntriesController.ts

@@ -1,4 +1,5 @@
 import FetchHandler from "../../handlers/fetchHandler";
+import { normalizeToCamelCase } from "../../handlers/normalize-casing";
 import ContentEntry from "../../types/content/contentEntry";
 import Status from "../../types/content/status";
 import { API_URL } from "../../constants/config";
@@ -22,7 +23,8 @@ class ContentEntriesController {
     if (statusFilter !== null) {
       url += `&statusFilter=${statusFilter}`;
     }
-    return fetchHandler.get<ContentEntry[]>(url, true, authToken);
+    const response = await fetchHandler.get<ContentEntry[]>(url, true, authToken);
+    return normalizeToCamelCase(response);
   }
 
   /**
@@ -41,7 +43,30 @@ class ContentEntriesController {
     if (statusFilter !== null) {
       url += `?statusFilter=${statusFilter}`;
     }
-    return fetchHandler.get<ContentEntry>(url, true, authToken);
+    const response = await fetchHandler.get<ContentEntry>(url, true, authToken);
+    return normalizeToCamelCase(response);
+  }
+
+  /**
+   * Get a specific content entry by content model ID + slug.
+   * @param {string} contentId - The content model ID.
+   * @param {string} slug - The entry slug.
+   * @param {Status | null} statusFilter - Optional status filter.
+   * @param {string | null} authToken - Optional auth token.
+   * @returns {Promise<ContentEntry>} - The content entry data.
+   */
+  async getContentEntryBySlug(
+    contentId: string,
+    slug: string,
+    statusFilter: Status | null = null,
+    authToken: string | null = null,
+  ): Promise<ContentEntry> {
+    let url = `/contententry/by-slug?contentId=${encodeURIComponent(contentId)}&slug=${encodeURIComponent(slug)}`;
+    if (statusFilter !== null) {
+      url += `&statusFilter=${statusFilter}`;
+    }
+    const response = await fetchHandler.get<ContentEntry>(url, true, authToken);
+    return normalizeToCamelCase(response);
   }
 
   /**
@@ -54,12 +79,13 @@ class ContentEntriesController {
     entry: ContentEntry,
     authToken: string | null = null,
   ): Promise<ContentEntry> {
-    return fetchHandler.post<ContentEntry, ContentEntry>(
+    const response = await fetchHandler.post<ContentEntry, ContentEntry>(
       "/contententry",
       entry,
       true,
       authToken,
     );
+    return normalizeToCamelCase(response);
   }
 
   /**
@@ -105,11 +131,12 @@ class ContentEntriesController {
     id: string,
     authToken: string | null = null,
   ): Promise<ContentEntry[]> {
-    return fetchHandler.get<ContentEntry[]>(
+    const response = await fetchHandler.get<ContentEntry[]>(
       `/contententry/${id}/versions`,
       true,
       authToken,
     );
+    return normalizeToCamelCase(response);
   }
 
   /**

package/controllers/jobListingsController.ts

@@ -8,6 +8,42 @@ const fetchHandler = new FetchHandler(API_URL);
  * Controller for handling job listing API requests.
  */
 class JobListingsController {
+  async updateFieldVersionApproval(
+    id: string,
+    payload: {
+      fieldPath: string;
+      timestamp?: string;
+      listingVersionNumber?: number;
+      needsApproval: boolean;
+    },
+    authToken: string | null = null
+  ): Promise<void> {
+    return fetchHandler.patch<typeof payload, void>(
+      `/joblistings/${id}/field-version-approval`,
+      payload,
+      true,
+      authToken
+    );
+  }
+
+  async updateDescriptionVersionApproval(
+    id: string,
+    payload: {
+      descriptionId: string;
+      versionId?: number;
+      listingVersionNumber?: number;
+      needsApproval: boolean;
+    },
+    authToken: string | null = null
+  ): Promise<void> {
+    return fetchHandler.patch<typeof payload, void>(
+      `/joblistings/${id}/description-version-approval`,
+      payload,
+      true,
+      authToken
+    );
+  }
+
   /**
    * [GET /joblistings]
    * Get all job listings for the authenticated user's company.

package/dist/constants/cms.d.ts

@@ -0,0 +1,53 @@
+export declare const BLOCK_KEYS: {
+    readonly HERO: "hero";
+    readonly VIDEO_BLOCK: "videoBlock";
+    readonly CONTENT_CARD: "contentCard";
+    readonly ICON_CARD: "iconCard";
+    readonly LIST: "list";
+    readonly CONTAINER: "container";
+    readonly ACCORDION: "accordion";
+    readonly TESTIMONIAL: "testimonial";
+    readonly LARGE_TITLE_BLOCK: "largeTitleBlock";
+    readonly BUTTON: "button";
+    readonly RECRUITER: "recruiter";
+    readonly BLOBS: "blobs";
+    readonly TITLE_MODULAR_CONTENT_COPY: "titleModularContentCopy";
+    readonly INTRO_WITH_CONTENT_CARD: "introWithContentCard";
+    readonly CALLOUT_CARD: "calloutCard";
+};
+export declare const BLOCK_KEY_ALIASES: Record<string, string>;
+export declare const FIELD_TYPES: {
+    readonly SINGLE_LINE_STRING: "SingleLineString";
+    readonly MULTI_LINE_TEXT: "MultiLineText";
+    readonly MULTIPLE_PARAGRAPH_TEXT: "MultipleParagraphText";
+    readonly SLUG: "Slug";
+    readonly STRUCTURED_TEXT: "StructuredText";
+    readonly RICH_TEXT: "RichText";
+    readonly INTEGER_NUMBER: "IntegerNumber";
+    readonly FLOATING_POINT_NUMBER: "FloatingPointNumber";
+    readonly BOOLEAN: "Boolean";
+    readonly DATE: "Date";
+    readonly DATE_TIME: "DateTime";
+    readonly SINGLE_MEDIA: "SingleMedia";
+    readonly MEDIA_GALLERY: "MediaGallery";
+    readonly EXTERNAL_VIDEO: "ExternalVideo";
+    readonly COLOR: "Color";
+    readonly TAILWIND_COLOR_SELECTOR: "TailwindColorSelector";
+    readonly SINGLE_LINK: "SingleLink";
+    readonly MULTIPLE_LINKS: "MultipleLinks";
+    readonly LOCATION: "Location";
+    readonly JSON: "Json";
+    readonly SEO: "Seo";
+    readonly MODULAR_CONTENT: "ModularContent";
+    readonly SINGLE_BLOCK: "SingleBlock";
+    readonly JOB_FILTER: "JobFilter";
+    readonly FORM: "Form";
+    readonly SINGLE_CONTENT_REFERENCE: "SingleContentReference";
+    readonly MULTIPLE_CONTENT_REFERENCE: "MultipleContentReference";
+    readonly HIRE_CONTROL_MAP: "HireControlMap";
+    readonly RECRUITER_SELECTOR: "RecruiterSelector";
+    readonly TAGS: "Tags";
+    readonly VARIANT_SELECTOR: "VariantSelector";
+};
+export type BlockKey = (typeof BLOCK_KEYS)[keyof typeof BLOCK_KEYS];
+export type FieldType = (typeof FIELD_TYPES)[keyof typeof FIELD_TYPES];

package/dist/controllers/categoryListsController.d.ts

@@ -1,4 +1,4 @@
-import CategoryListDto, { AddValueRequest } from "../types/categoryList";
+import CategoryListDto, { AddValueRequest, CategoryListValueDto } from "../types/categoryList";
 declare class CategoryListsController {
     /**
      * Get all category lists for the authenticated user's company.
@@ -75,11 +75,20 @@ declare class CategoryListsController {
     /**
      * Update values in a category list.
      * @param {string} id - The category list ID.
-     * @param {Record<string, string>} values - The values to update.
+     * @param {Record<string, CategoryListDto["values"][string]>} values - The values to update.
      * @param {string | null} authToken - Optional auth token.
      * @returns {Promise<CategoryListDto>} - The updated category list data.
      */
-    updateValues(id: string, values: Record<string, string>, authToken?: string | null): Promise<CategoryListDto>;
+    updateValues(id: string, values: Record<string, CategoryListDto["values"][string]>, authToken?: string | null): Promise<CategoryListDto>;
+    /**
+     * Update a single value in a category list.
+     * @param {string} id - The category list ID.
+     * @param {string} key - The value key to update.
+     * @param {CategoryListValueDto} value - The value payload.
+     * @param {string | null} authToken - Optional auth token.
+     * @returns {Promise<CategoryListDto>} - The updated category list data.
+     */
+    updateValue(id: string, key: string, value: CategoryListValueDto, authToken?: string | null): Promise<CategoryListDto>;
 }
 declare const _default: CategoryListsController;
 export default _default;

package/dist/controllers/content/blocksController.d.ts

@@ -1,4 +1,5 @@
 import Block from "../../types/content/block";
+import { BlockUpdateImpact, BlockFieldMigration } from "../../types/content/blockUpdateImpact";
 declare class BlocksController {
     /**
      * Get all blocks for the current company.
@@ -28,6 +29,15 @@ declare class BlocksController {
      * @returns {Promise<void>} - No return value.
      */
     updateBlock(id: string, block: Block, authToken?: string | null): Promise<void>;
+    /**
+     * Update an existing block and apply optional field migrations.
+     * Backward compatible with the legacy PUT body.
+     */
+    updateBlockWithMigrations(id: string, block: Block, fieldMigrations?: BlockFieldMigration[], authToken?: string | null): Promise<void>;
+    /**
+     * Preview the impact of updating a block definition before saving it.
+     */
+    previewBlockUpdate(id: string, block: Block, authToken?: string | null): Promise<BlockUpdateImpact>;
     /**
      * Delete an existing block.
      * @param {string} id - The block ID to delete.

package/dist/controllers/content/contentEntriesController.d.ts

@@ -17,6 +17,15 @@ declare class ContentEntriesController {
      * @returns {Promise<ContentEntry>} - The content entry data.
      */
     getContentEntry(id: string, statusFilter?: Status | null, authToken?: string | null): Promise<ContentEntry>;
+    /**
+     * Get a specific content entry by content model ID + slug.
+     * @param {string} contentId - The content model ID.
+     * @param {string} slug - The entry slug.
+     * @param {Status | null} statusFilter - Optional status filter.
+     * @param {string | null} authToken - Optional auth token.
+     * @returns {Promise<ContentEntry>} - The content entry data.
+     */
+    getContentEntryBySlug(contentId: string, slug: string, statusFilter?: Status | null, authToken?: string | null): Promise<ContentEntry>;
     /**
      * Create a new content entry.
      * @param {ContentEntry} entry - The content entry data to create.

package/dist/controllers/jobListingsController.d.ts

@@ -3,6 +3,18 @@ import { type JobListing } from "../types/JobListing";
  * Controller for handling job listing API requests.
  */
 declare class JobListingsController {
+    updateFieldVersionApproval(id: string, payload: {
+        fieldPath: string;
+        timestamp?: string;
+        listingVersionNumber?: number;
+        needsApproval: boolean;
+    }, authToken?: string | null): Promise<void>;
+    updateDescriptionVersionApproval(id: string, payload: {
+        descriptionId: string;
+        versionId?: number;
+        listingVersionNumber?: number;
+        needsApproval: boolean;
+    }, authToken?: string | null): Promise<void>;
     /**
      * [GET /joblistings]
      * Get all job listings for the authenticated user's company.

package/dist/handlers/normalize-casing.d.ts

@@ -0,0 +1 @@
+export declare const normalizeToCamelCase: <T>(value: T) => T;