@pacp/spec 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,223 @@
+export { profileIds, profiles, schema } from './schema.js';
+
+type ScalarValue = string | number | boolean;
+type ImageType = "MAIN" | "DETAIL" | "AMBIANCE" | "TECHNICAL" | "OTHER";
+interface ImageRef {
+    url: string;
+    label?: string;
+    type?: ImageType;
+}
+interface Measure {
+    value: number;
+    unit: string;
+}
+interface DimensionsObj {
+    width?: number;
+    height?: number;
+    depth?: number;
+    unit: string;
+}
+interface AttributeRef {
+    id: string;
+    label?: string;
+}
+interface AttributeValue {
+    attributeId: string;
+    value: ScalarValue;
+    label?: string;
+}
+interface Option {
+    id: string;
+    attributeId: string;
+    value: ScalarValue;
+    label?: string;
+}
+interface LotPolicy {
+    required: boolean;
+    source: "CONTEXT" | "ATTRIBUTE";
+    contextKey?: string;
+    attributeId?: string;
+}
+interface SalesUnit {
+    requested_unit: string;
+    sell_unit: string;
+    quantity_per_sell_unit: number;
+    rounding: "CEIL";
+    min_sell_units?: number;
+}
+interface Product {
+    id: string;
+    name?: string;
+    sku?: string;
+    manufacturer?: string;
+    brand?: string;
+    description?: string;
+    category?: string;
+    gtin?: string;
+    base_price?: number;
+    images?: ImageRef[];
+    tags?: string[];
+    weight?: Measure;
+    dimensions?: DimensionsObj;
+    lot_policy?: LotPolicy;
+    sales_unit?: SalesUnit;
+    attributes?: AttributeRef[];
+    attribute_values?: AttributeValue[];
+    options: Option[];
+    rulesetIds?: string[];
+    [key: `x-${string}`]: unknown;
+}
+interface Predicate {
+    fact: string;
+    operator: "EQ" | "NEQ" | "IN" | "NOT_IN" | "GT" | "GTE" | "LT" | "LTE" | "EXISTS";
+    value?: ScalarValue;
+    values?: ScalarValue[];
+}
+interface Condition {
+    all?: Predicate[];
+    any?: Predicate[];
+}
+interface Component {
+    label?: string;
+    value?: number;
+    tableId?: string;
+    optionId?: string;
+}
+type RuleOperation = "ADD" | "PERCENT_OF" | "OVERRIDE" | "LOOKUP" | "MAX_OF" | "MIN_OF" | "PICK" | "ROUND" | "CAP" | "FLOOR";
+interface Rule {
+    id: string;
+    operation: RuleOperation;
+    priority?: number;
+    enabled?: boolean;
+    when?: Condition;
+    value?: number;
+    percent?: number;
+    tableId?: string;
+    components?: Component[];
+    precision?: number;
+    max?: number;
+    min?: number;
+    fallback?: number;
+    optionId?: string;
+    optionIds?: string[];
+    [key: `x-${string}`]: unknown;
+}
+interface Ruleset {
+    id: string;
+    target: "BASE" | "SUBTOTAL" | "TOTAL";
+    rules: Rule[];
+    [key: `x-${string}`]: unknown;
+}
+interface Dimension {
+    key: string;
+    source: "ATTRIBUTE" | "CONTEXT" | "LITERAL";
+    attributeId?: string;
+    contextKey?: string;
+    literal?: ScalarValue;
+}
+interface TableRow {
+    key: Record<string, ScalarValue>;
+    value: number;
+}
+interface Table {
+    id: string;
+    type: "LOOKUP";
+    dimensions: Dimension[];
+    rows: TableRow[];
+    keys?: (string | {
+        optionId?: string;
+        id?: string;
+        name?: string;
+    })[];
+}
+interface Dependency {
+    id: string;
+    type: "REQUIRES" | "IMPLIES" | "AVAILABLE_OPTIONS_WHEN";
+    productId?: string;
+    optionId?: string;
+    requiresOptionIds?: string[];
+    allowedOptionIds?: string[];
+    when?: Condition;
+}
+interface Constraint {
+    id: string;
+    type: "DENY";
+    when: Condition;
+    message: string;
+    productId?: string;
+    optionIds?: string[];
+}
+interface PriceList {
+    id: string;
+    currency: string;
+    label?: string;
+    context_match?: Record<string, ScalarValue>;
+}
+interface Catalog {
+    id: string;
+    name?: string;
+    default_price_list_id?: string;
+    price_lists?: PriceList[];
+    [key: `x-${string}`]: unknown;
+}
+interface ProductRef {
+    id: string;
+    path: string;
+}
+interface Context {
+    price_list_id?: string;
+    region?: string;
+    channel?: string;
+    customer?: string;
+    lot_id?: string;
+    requested_quantity?: number;
+    requested_unit?: string;
+    [key: `x-${string}`]: unknown;
+}
+interface Pricing {
+    calculation_mode?: "CASCADE" | "TABLE_LOOKUP" | "OVERRIDE_BY_VARIANT" | "COST_PLUS";
+}
+interface CatalogDocument {
+    spec: "1.0.0";
+    document_type: "CATALOG";
+    catalog: Catalog;
+    rulesets: Ruleset[];
+    product_refs?: ProductRef[];
+    context?: Context;
+    pricing?: Pricing;
+    dictionaries?: Record<string, unknown>;
+    tables?: Table[];
+    dependencies?: Dependency[];
+    constraints?: Constraint[];
+    profiles?: string[];
+    [key: `x-${string}`]: unknown;
+}
+interface ProductDocument {
+    spec: "1.0.0";
+    document_type: "PRODUCT";
+    catalog_id: string;
+    product: Product;
+    rulesets?: Ruleset[];
+    tables?: Table[];
+    constraints?: Constraint[];
+    dependencies?: Dependency[];
+    profiles?: string[];
+    [key: `x-${string}`]: unknown;
+}
+type PacpDocument = CatalogDocument | ProductDocument;
+type ProfileId = "moveis" | "iluminacao" | "pisos-revestimentos" | "fiscal-br";
+interface ValidationIssue {
+    code: string;
+    path: string;
+    message: string;
+}
+interface ValidationResult {
+    valid: boolean;
+    issues: ValidationIssue[];
+}
+
+declare function validate(document: unknown): ValidationResult;
+
+declare const SPEC_VERSION: "1.0.0";
+
+export { type AttributeRef, type AttributeValue, type Catalog, type CatalogDocument, type Component, type Condition, type Constraint, type Context, type Dependency, type Dimension, type DimensionsObj, type ImageRef, type ImageType, type LotPolicy, type Measure, type Option, type PacpDocument, type Predicate, type PriceList, type Pricing, type Product, type ProductDocument, type ProductRef, type ProfileId, type Rule, type RuleOperation, type Ruleset, SPEC_VERSION, type SalesUnit, type ScalarValue, type Table, type TableRow, type ValidationIssue, type ValidationResult, validate };

package/dist/index.js

@@ -0,0 +1,116 @@
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+// node_modules/tsup/assets/esm_shims.js
+import path from "path";
+import { fileURLToPath } from "url";
+var getFilename = () => fileURLToPath(import.meta.url);
+var getDirname = () => path.dirname(getFilename());
+var __dirname = /* @__PURE__ */ getDirname();
+
+// src/schema.ts
+import { readFileSync } from "fs";
+import { join } from "path";
+function loadJson(relativePath) {
+  const fullPath = join(__dirname, relativePath);
+  return JSON.parse(readFileSync(fullPath, "utf8"));
+}
+var schema = loadJson("./pacp.schema.json");
+var profiles = {
+  moveis: loadJson("./profiles/moveis.schema.json"),
+  iluminacao: loadJson("./profiles/iluminacao.schema.json"),
+  "pisos-revestimentos": loadJson("./profiles/pisos-revestimentos.schema.json"),
+  "fiscal-br": loadJson("./profiles/fiscal-br.schema.json")
+};
+var profileIds = Object.keys(profiles);
+
+// src/validate.ts
+function validate(document) {
+  let Ajv2020;
+  let addFormats;
+  try {
+    Ajv2020 = __require("ajv/dist/2020");
+    addFormats = __require("ajv-formats");
+  } catch {
+    throw new Error(
+      "Para usar validate(), instale ajv e ajv-formats: npm install ajv ajv-formats"
+    );
+  }
+  const ajv = new Ajv2020({ allErrors: true, strict: false });
+  addFormats(ajv);
+  const issues = [];
+  const validateSchema = ajv.compile(schema);
+  const valid = validateSchema(document);
+  if (!valid && validateSchema.errors) {
+    for (const error of validateSchema.errors) {
+      issues.push({
+        code: "SCHEMA",
+        path: error.instancePath || "/",
+        message: error.message ?? "Erro de validacao de schema"
+      });
+    }
+  }
+  if (document && typeof document === "object" && !Array.isArray(document)) {
+    const doc = document;
+    const declaredProfiles = Array.isArray(doc.profiles) ? doc.profiles : [];
+    for (const profileId of declaredProfiles) {
+      if (typeof profileId !== "string") continue;
+      const profileSchema = profiles[profileId];
+      if (!profileSchema) {
+        issues.push({
+          code: "UNKNOWN_PROFILE",
+          path: "/profiles",
+          message: `Profile "${profileId}" nao e um profile oficial PACP`
+        });
+        continue;
+      }
+      const products = extractProducts(doc);
+      const validateProfile = ajv.compile(profileSchema);
+      for (let i = 0; i < products.length; i++) {
+        const xFields = extractXFields(products[i]);
+        if (Object.keys(xFields).length === 0) continue;
+        const profileValid = validateProfile(xFields);
+        if (!profileValid && validateProfile.errors) {
+          for (const error of validateProfile.errors) {
+            issues.push({
+              code: "PROFILE_VALIDATION",
+              path: `products[${i}]${error.instancePath || "/"}`,
+              message: `Profile "${profileId}": ${error.message ?? "erro de validacao"}`
+            });
+          }
+        }
+      }
+    }
+  }
+  return { valid: issues.length === 0, issues };
+}
+function extractProducts(doc) {
+  if (doc.document_type === "PRODUCT" && doc.product && typeof doc.product === "object") {
+    return [doc.product];
+  }
+  return [];
+}
+function extractXFields(obj) {
+  const result = {};
+  for (const [key, value] of Object.entries(obj)) {
+    if (key.startsWith("x-")) {
+      result[key] = value;
+    }
+  }
+  return result;
+}
+
+// src/index.ts
+var SPEC_VERSION = "1.0.0";
+export {
+  SPEC_VERSION,
+  profileIds,
+  profiles,
+  schema,
+  validate
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../node_modules/tsup/assets/esm_shims.js","../src/schema.ts","../src/validate.ts","../src/index.ts"],"sourcesContent":["// Shim globals in esm bundle\nimport path from 'node:path'\nimport { fileURLToPath } from 'node:url'\n\nconst getFilename = () => fileURLToPath(import.meta.url)\nconst getDirname = () => path.dirname(getFilename())\n\nexport const __dirname = /* @__PURE__ */ getDirname()\nexport const __filename = /* @__PURE__ */ getFilename()\n","import { readFileSync } from \"node:fs\";\r\nimport { join } from \"node:path\";\r\n\r\nfunction loadJson(relativePath: string): Record<string, unknown> {\r\n  const fullPath = join(__dirname, relativePath);\r\n  return JSON.parse(readFileSync(fullPath, \"utf8\"));\r\n}\r\n\r\nexport const schema = loadJson(\"./pacp.schema.json\") as Record<string, unknown>;\r\n\r\nexport const profiles = {\r\n  moveis: loadJson(\"./profiles/moveis.schema.json\") as Record<string, unknown>,\r\n  iluminacao: loadJson(\"./profiles/iluminacao.schema.json\") as Record<string, unknown>,\r\n  \"pisos-revestimentos\": loadJson(\"./profiles/pisos-revestimentos.schema.json\") as Record<string, unknown>,\r\n  \"fiscal-br\": loadJson(\"./profiles/fiscal-br.schema.json\") as Record<string, unknown>,\r\n} as const;\r\n\r\nexport type ProfileId = keyof typeof profiles;\r\n\r\nexport const profileIds = Object.keys(profiles) as ProfileId[];\r\n","import type { ValidationResult, ValidationIssue, PacpDocument } from \"./types.js\";\r\nimport { schema, profiles, type ProfileId } from \"./schema.js\";\r\n\r\nexport function validate(document: unknown): ValidationResult {\r\n  let Ajv2020: typeof import(\"ajv/dist/2020\").default;\r\n  let addFormats: typeof import(\"ajv-formats\").default;\r\n\r\n  try {\r\n    Ajv2020 = require(\"ajv/dist/2020\") as typeof import(\"ajv/dist/2020\").default;\r\n    addFormats = require(\"ajv-formats\") as typeof import(\"ajv-formats\").default;\r\n  } catch {\r\n    throw new Error(\r\n      'Para usar validate(), instale ajv e ajv-formats: npm install ajv ajv-formats'\r\n    );\r\n  }\r\n\r\n  const ajv = new Ajv2020({ allErrors: true, strict: false });\r\n  addFormats(ajv);\r\n\r\n  const issues: ValidationIssue[] = [];\r\n\r\n  const validateSchema = ajv.compile(schema);\r\n  const valid = validateSchema(document);\r\n\r\n  if (!valid && validateSchema.errors) {\r\n    for (const error of validateSchema.errors) {\r\n      issues.push({\r\n        code: \"SCHEMA\",\r\n        path: error.instancePath || \"/\",\r\n        message: error.message ?? \"Erro de validacao de schema\",\r\n      });\r\n    }\r\n  }\r\n\r\n  if (document && typeof document === \"object\" && !Array.isArray(document)) {\r\n    const doc = document as Record<string, unknown>;\r\n    const declaredProfiles = Array.isArray(doc.profiles) ? doc.profiles : [];\r\n\r\n    for (const profileId of declaredProfiles) {\r\n      if (typeof profileId !== \"string\") continue;\r\n\r\n      const profileSchema = profiles[profileId as ProfileId];\r\n      if (!profileSchema) {\r\n        issues.push({\r\n          code: \"UNKNOWN_PROFILE\",\r\n          path: \"/profiles\",\r\n          message: `Profile \"${profileId}\" nao e um profile oficial PACP`,\r\n        });\r\n        continue;\r\n      }\r\n\r\n      const products = extractProducts(doc);\r\n      const validateProfile = ajv.compile(profileSchema);\r\n\r\n      for (let i = 0; i < products.length; i++) {\r\n        const xFields = extractXFields(products[i]);\r\n        if (Object.keys(xFields).length === 0) continue;\r\n\r\n        const profileValid = validateProfile(xFields);\r\n        if (!profileValid && validateProfile.errors) {\r\n          for (const error of validateProfile.errors) {\r\n            issues.push({\r\n              code: \"PROFILE_VALIDATION\",\r\n              path: `products[${i}]${error.instancePath || \"/\"}`,\r\n              message: `Profile \"${profileId}\": ${error.message ?? \"erro de validacao\"}`,\r\n            });\r\n          }\r\n        }\r\n      }\r\n    }\r\n  }\r\n\r\n  return { valid: issues.length === 0, issues };\r\n}\r\n\r\nfunction extractProducts(doc: Record<string, unknown>): Record<string, unknown>[] {\r\n  if (doc.document_type === \"PRODUCT\" && doc.product && typeof doc.product === \"object\") {\r\n    return [doc.product as Record<string, unknown>];\r\n  }\r\n  return [];\r\n}\r\n\r\nfunction extractXFields(obj: Record<string, unknown>): Record<string, unknown> {\r\n  const result: Record<string, unknown> = {};\r\n  for (const [key, value] of Object.entries(obj)) {\r\n    if (key.startsWith(\"x-\")) {\r\n      result[key] = value;\r\n    }\r\n  }\r\n  return result;\r\n}\r\n","export { schema, profiles, profileIds } from \"./schema.js\";\r\nexport { validate } from \"./validate.js\";\r\nexport type {\r\n  ScalarValue,\r\n  ImageType,\r\n  ImageRef,\r\n  Measure,\r\n  DimensionsObj,\r\n  AttributeRef,\r\n  AttributeValue,\r\n  Option,\r\n  LotPolicy,\r\n  SalesUnit,\r\n  Product,\r\n  Predicate,\r\n  Condition,\r\n  Component,\r\n  RuleOperation,\r\n  Rule,\r\n  Ruleset,\r\n  Dimension,\r\n  TableRow,\r\n  Table,\r\n  Dependency,\r\n  Constraint,\r\n  PriceList,\r\n  Catalog,\r\n  ProductRef,\r\n  Context,\r\n  Pricing,\r\n  CatalogDocument,\r\n  ProductDocument,\r\n  PacpDocument,\r\n  ProfileId,\r\n  ValidationIssue,\r\n  ValidationResult,\r\n} from \"./types.js\";\r\n\r\nexport const SPEC_VERSION = \"1.0.0\" as const;\r\n"],"mappings":";;;;;;;;AACA,OAAO,UAAU;AACjB,SAAS,qBAAqB;AAE9B,IAAM,cAAc,MAAM,cAAc,YAAY,GAAG;AACvD,IAAM,aAAa,MAAM,KAAK,QAAQ,YAAY,CAAC;AAE5C,IAAM,YAA4B,2BAAW;;;ACPpD,SAAS,oBAAoB;AAC7B,SAAS,YAAY;AAErB,SAAS,SAAS,cAA+C;AAC/D,QAAM,WAAW,KAAK,WAAW,YAAY;AAC7C,SAAO,KAAK,MAAM,aAAa,UAAU,MAAM,CAAC;AAClD;AAEO,IAAM,SAAS,SAAS,oBAAoB;AAE5C,IAAM,WAAW;AAAA,EACtB,QAAQ,SAAS,+BAA+B;AAAA,EAChD,YAAY,SAAS,mCAAmC;AAAA,EACxD,uBAAuB,SAAS,4CAA4C;AAAA,EAC5E,aAAa,SAAS,kCAAkC;AAC1D;AAIO,IAAM,aAAa,OAAO,KAAK,QAAQ;;;AChBvC,SAAS,SAAS,UAAqC;AAC5D,MAAI;AACJ,MAAI;AAEJ,MAAI;AACF,cAAU,UAAQ,eAAe;AACjC,iBAAa,UAAQ,aAAa;AAAA,EACpC,QAAQ;AACN,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,QAAM,MAAM,IAAI,QAAQ,EAAE,WAAW,MAAM,QAAQ,MAAM,CAAC;AAC1D,aAAW,GAAG;AAEd,QAAM,SAA4B,CAAC;AAEnC,QAAM,iBAAiB,IAAI,QAAQ,MAAM;AACzC,QAAM,QAAQ,eAAe,QAAQ;AAErC,MAAI,CAAC,SAAS,eAAe,QAAQ;AACnC,eAAW,SAAS,eAAe,QAAQ;AACzC,aAAO,KAAK;AAAA,QACV,MAAM;AAAA,QACN,MAAM,MAAM,gBAAgB;AAAA,QAC5B,SAAS,MAAM,WAAW;AAAA,MAC5B,CAAC;AAAA,IACH;AAAA,EACF;AAEA,MAAI,YAAY,OAAO,aAAa,YAAY,CAAC,MAAM,QAAQ,QAAQ,GAAG;AACxE,UAAM,MAAM;AACZ,UAAM,mBAAmB,MAAM,QAAQ,IAAI,QAAQ,IAAI,IAAI,WAAW,CAAC;AAEvE,eAAW,aAAa,kBAAkB;AACxC,UAAI,OAAO,cAAc,SAAU;AAEnC,YAAM,gBAAgB,SAAS,SAAsB;AACrD,UAAI,CAAC,eAAe;AAClB,eAAO,KAAK;AAAA,UACV,MAAM;AAAA,UACN,MAAM;AAAA,UACN,SAAS,YAAY,SAAS;AAAA,QAChC,CAAC;AACD;AAAA,MACF;AAEA,YAAM,WAAW,gBAAgB,GAAG;AACpC,YAAM,kBAAkB,IAAI,QAAQ,aAAa;AAEjD,eAAS,IAAI,GAAG,IAAI,SAAS,QAAQ,KAAK;AACxC,cAAM,UAAU,eAAe,SAAS,CAAC,CAAC;AAC1C,YAAI,OAAO,KAAK,OAAO,EAAE,WAAW,EAAG;AAEvC,cAAM,eAAe,gBAAgB,OAAO;AAC5C,YAAI,CAAC,gBAAgB,gBAAgB,QAAQ;AAC3C,qBAAW,SAAS,gBAAgB,QAAQ;AAC1C,mBAAO,KAAK;AAAA,cACV,MAAM;AAAA,cACN,MAAM,YAAY,CAAC,IAAI,MAAM,gBAAgB,GAAG;AAAA,cAChD,SAAS,YAAY,SAAS,MAAM,MAAM,WAAW,mBAAmB;AAAA,YAC1E,CAAC;AAAA,UACH;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO,EAAE,OAAO,OAAO,WAAW,GAAG,OAAO;AAC9C;AAEA,SAAS,gBAAgB,KAAyD;AAChF,MAAI,IAAI,kBAAkB,aAAa,IAAI,WAAW,OAAO,IAAI,YAAY,UAAU;AACrF,WAAO,CAAC,IAAI,OAAkC;AAAA,EAChD;AACA,SAAO,CAAC;AACV;AAEA,SAAS,eAAe,KAAuD;AAC7E,QAAM,SAAkC,CAAC;AACzC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,GAAG,GAAG;AAC9C,QAAI,IAAI,WAAW,IAAI,GAAG;AACxB,aAAO,GAAG,IAAI;AAAA,IAChB;AAAA,EACF;AACA,SAAO;AACT;;;ACpDO,IAAM,eAAe;","names":[]}