@munchi_oy/license-sdk 0.4.0 → 0.5.0

package/README.md

@@ -32,3 +32,5 @@ const snapshot = await license.entitlements(venueId); // full snapshot, null = u
 Call `invalidate(venueId)` when you receive a `license.changed` event.
 
 It also exports the shared names: `PRODUCTS` and `PLANS` (catalog codes), `USAGE_METRICS` (what usage can cost money) and `REQUESTABLE_PRODUCTS` (what a store asks Munchi for in the dashboard: `ari`, `business_account`, `capital`).
+
+For a group's company (ADR 0025) it exports `companyIds(country, { businessId, vatId })` (the IDs to store by the company's country, or `{ invalid: "businessId" | "vatId" }`; any country is accepted, Finland's are checked), `finnishBusinessId(input)` (the Y-tunnus as `NNNNNNN-C`, or `null` when its format or check digit is wrong), `finnishVatId(businessId)` (`FI` and its digits), and the types `LegalEntityChange` (the body of `PATCH /v1/accounts/:accountId/legal-entities/:legalEntityId`) and `LegalEntity` (its response).

package/dist/index.cjs

@@ -26,7 +26,10 @@ __export(index_exports, {
   PRODUCTS: () => PRODUCTS,
   REQUESTABLE_PRODUCTS: () => REQUESTABLE_PRODUCTS,
   USAGE_METRICS: () => USAGE_METRICS,
-  USAGE_METRIC_NAMES: () => USAGE_METRIC_NAMES
+  USAGE_METRIC_NAMES: () => USAGE_METRIC_NAMES,
+  companyIds: () => companyIds,
+  finnishBusinessId: () => finnishBusinessId,
+  finnishVatId: () => finnishVatId
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -45,6 +48,55 @@ var PLANS = [
   PRODUCTS.one
 ];
 
+// ../license-core/src/legal-entity.ts
+var Y_TUNNUS = /^(\d{6,7})-(\d)$/;
+var Y_TUNNUS_WEIGHTS = [
+  7,
+  9,
+  10,
+  5,
+  8,
+  4,
+  2
+];
+var finnishBusinessId = /* @__PURE__ */ __name((input) => {
+  const [, body, check] = Y_TUNNUS.exec(input.trim()) ?? [];
+  if (body === void 0 || check === void 0) return null;
+  const digits = body.padStart(7, "0");
+  const remainder = Y_TUNNUS_WEIGHTS.reduce((sum, weight, index) => sum + weight * Number(digits[index]), 0) % 11;
+  const expected = remainder === 0 ? 0 : 11 - remainder;
+  return Number(check) === expected ? `${digits}-${check}` : null;
+}, "finnishBusinessId");
+var finnishVatId = /* @__PURE__ */ __name((businessId) => `FI${businessId.replace("-", "")}`, "finnishVatId");
+var ANY_COUNTRY = {
+  businessId: /* @__PURE__ */ __name((input) => input.trim() || null, "businessId"),
+  vatId: /* @__PURE__ */ __name((_businessId, input) => input?.trim() || null, "vatId")
+};
+var COMPANY_IDS_BY_COUNTRY = {
+  FI: {
+    businessId: finnishBusinessId,
+    vatId: /* @__PURE__ */ __name((businessId, input) => {
+      const vatId = finnishVatId(businessId);
+      return input === null || input.replace(/\s/g, "").toUpperCase() === vatId ? vatId : void 0;
+    }, "vatId")
+  }
+};
+var companyIds = /* @__PURE__ */ __name((country, input) => {
+  const rules = COMPANY_IDS_BY_COUNTRY[country.toUpperCase()] ?? ANY_COUNTRY;
+  const businessId = rules.businessId(input.businessId);
+  if (businessId === null) return {
+    invalid: "businessId"
+  };
+  const vatId = rules.vatId(businessId, input.vatId ?? null);
+  if (vatId === void 0) return {
+    invalid: "vatId"
+  };
+  return {
+    businessId,
+    vatId
+  };
+}, "companyIds");
+
 // ../license-core/src/requestable-products.ts
 var REQUESTABLE_PRODUCTS = [
   "ari",
@@ -204,5 +256,8 @@ var LicenseClient = class {
   PRODUCTS,
   REQUESTABLE_PRODUCTS,
   USAGE_METRICS,
-  USAGE_METRIC_NAMES
+  USAGE_METRIC_NAMES,
+  companyIds,
+  finnishBusinessId,
+  finnishVatId
 });

package/dist/index.d.cts

@@ -16,6 +16,54 @@ type KnownProductCode = (typeof PRODUCTS)[keyof typeof PRODUCTS];
 declare const PLANS: readonly ["MUN-START", "MUN-ONE"];
 type PlanCode = (typeof PLANS)[number];
 
+/**
+ * A group's company (legal entity), as the dashboard reads and changes it. One company can be the
+ * company of several stores of the same group. Zero-dependency on purpose: the SDK ships it.
+ */
+interface LegalEntity {
+    legalEntityId: string;
+    accountId: string;
+    /** ISO 3166-1 alpha-2. Not changeable: Stripe Tax and the store's notices follow it. */
+    country: string;
+    name: string;
+    /** The country's company ID: the Y-tunnus (`NNNNNNN-C`) in Finland. */
+    businessId: string | null;
+    vatId: string | null;
+    /** The group's open stores that use this company. */
+    stores: Array<{
+        locationId: string;
+        venueId: number | null;
+        name: string;
+    }>;
+}
+/** Body of `PATCH /v1/accounts/:accountId/legal-entities/:legalEntityId`. */
+interface LegalEntityChange {
+    name: string;
+    businessId: string;
+    /** Omitted or `null`: derived where the country has a rule (`FI` + the Y-tunnus digits), else none. */
+    vatId?: string | null;
+    actorUserId: string;
+}
+/**
+ * The Finnish business ID (Y-tunnus) as `NNNNNNN-C`, or `null` when its format or check digit is
+ * wrong. Old six-digit IDs get the leading zero they are officially written with.
+ */
+declare const finnishBusinessId: (input: string) => string | null;
+/** A Finnish VAT ID is always `FI` and the business ID's eight digits. */
+declare const finnishVatId: (businessId: string) => string;
+/** The IDs to store, or the field that is wrong for the company's country. */
+type CompanyIds = {
+    businessId: string;
+    vatId: string | null;
+} | {
+    invalid: "businessId" | "vatId";
+};
+/** Checks and normalises a company's IDs by the rules of its country (ISO 3166-1 alpha-2). */
+declare const companyIds: (country: string, input: {
+    businessId: string;
+    vatId?: string | null;
+}) => CompanyIds;
+
 /**
  * Products a store asks Munchi for in the dashboard because they can't be bought online
  * (ADR 0022). These are the dashboard's product ids, not catalog codes (`MUN-*`); the mobile app
@@ -174,4 +222,4 @@ declare class LicenseClient {
     private report;
 }
 
-export { type DeniedEvent, type KnownProductCode, LicenseClient, type LicenseClientOptions, PLANS, PRODUCTS, type PlanCode, REQUESTABLE_PRODUCTS, type RequestableProduct, type Snapshot, USAGE_METRICS, USAGE_METRIC_NAMES, type UsageMetric };
+export { type CompanyIds, type DeniedEvent, type KnownProductCode, type LegalEntity, type LegalEntityChange, LicenseClient, type LicenseClientOptions, PLANS, PRODUCTS, type PlanCode, REQUESTABLE_PRODUCTS, type RequestableProduct, type Snapshot, USAGE_METRICS, USAGE_METRIC_NAMES, type UsageMetric, companyIds, finnishBusinessId, finnishVatId };

package/dist/index.d.ts

@@ -16,6 +16,54 @@ type KnownProductCode = (typeof PRODUCTS)[keyof typeof PRODUCTS];
 declare const PLANS: readonly ["MUN-START", "MUN-ONE"];
 type PlanCode = (typeof PLANS)[number];
 
+/**
+ * A group's company (legal entity), as the dashboard reads and changes it. One company can be the
+ * company of several stores of the same group. Zero-dependency on purpose: the SDK ships it.
+ */
+interface LegalEntity {
+    legalEntityId: string;
+    accountId: string;
+    /** ISO 3166-1 alpha-2. Not changeable: Stripe Tax and the store's notices follow it. */
+    country: string;
+    name: string;
+    /** The country's company ID: the Y-tunnus (`NNNNNNN-C`) in Finland. */
+    businessId: string | null;
+    vatId: string | null;
+    /** The group's open stores that use this company. */
+    stores: Array<{
+        locationId: string;
+        venueId: number | null;
+        name: string;
+    }>;
+}
+/** Body of `PATCH /v1/accounts/:accountId/legal-entities/:legalEntityId`. */
+interface LegalEntityChange {
+    name: string;
+    businessId: string;
+    /** Omitted or `null`: derived where the country has a rule (`FI` + the Y-tunnus digits), else none. */
+    vatId?: string | null;
+    actorUserId: string;
+}
+/**
+ * The Finnish business ID (Y-tunnus) as `NNNNNNN-C`, or `null` when its format or check digit is
+ * wrong. Old six-digit IDs get the leading zero they are officially written with.
+ */
+declare const finnishBusinessId: (input: string) => string | null;
+/** A Finnish VAT ID is always `FI` and the business ID's eight digits. */
+declare const finnishVatId: (businessId: string) => string;
+/** The IDs to store, or the field that is wrong for the company's country. */
+type CompanyIds = {
+    businessId: string;
+    vatId: string | null;
+} | {
+    invalid: "businessId" | "vatId";
+};
+/** Checks and normalises a company's IDs by the rules of its country (ISO 3166-1 alpha-2). */
+declare const companyIds: (country: string, input: {
+    businessId: string;
+    vatId?: string | null;
+}) => CompanyIds;
+
 /**
  * Products a store asks Munchi for in the dashboard because they can't be bought online
  * (ADR 0022). These are the dashboard's product ids, not catalog codes (`MUN-*`); the mobile app
@@ -174,4 +222,4 @@ declare class LicenseClient {
     private report;
 }
 
-export { type DeniedEvent, type KnownProductCode, LicenseClient, type LicenseClientOptions, PLANS, PRODUCTS, type PlanCode, REQUESTABLE_PRODUCTS, type RequestableProduct, type Snapshot, USAGE_METRICS, USAGE_METRIC_NAMES, type UsageMetric };
+export { type CompanyIds, type DeniedEvent, type KnownProductCode, type LegalEntity, type LegalEntityChange, LicenseClient, type LicenseClientOptions, PLANS, PRODUCTS, type PlanCode, REQUESTABLE_PRODUCTS, type RequestableProduct, type Snapshot, USAGE_METRICS, USAGE_METRIC_NAMES, type UsageMetric, companyIds, finnishBusinessId, finnishVatId };

package/dist/index.js

@@ -16,6 +16,55 @@ var PLANS = [
   PRODUCTS.one
 ];
 
+// ../license-core/src/legal-entity.ts
+var Y_TUNNUS = /^(\d{6,7})-(\d)$/;
+var Y_TUNNUS_WEIGHTS = [
+  7,
+  9,
+  10,
+  5,
+  8,
+  4,
+  2
+];
+var finnishBusinessId = /* @__PURE__ */ __name((input) => {
+  const [, body, check] = Y_TUNNUS.exec(input.trim()) ?? [];
+  if (body === void 0 || check === void 0) return null;
+  const digits = body.padStart(7, "0");
+  const remainder = Y_TUNNUS_WEIGHTS.reduce((sum, weight, index) => sum + weight * Number(digits[index]), 0) % 11;
+  const expected = remainder === 0 ? 0 : 11 - remainder;
+  return Number(check) === expected ? `${digits}-${check}` : null;
+}, "finnishBusinessId");
+var finnishVatId = /* @__PURE__ */ __name((businessId) => `FI${businessId.replace("-", "")}`, "finnishVatId");
+var ANY_COUNTRY = {
+  businessId: /* @__PURE__ */ __name((input) => input.trim() || null, "businessId"),
+  vatId: /* @__PURE__ */ __name((_businessId, input) => input?.trim() || null, "vatId")
+};
+var COMPANY_IDS_BY_COUNTRY = {
+  FI: {
+    businessId: finnishBusinessId,
+    vatId: /* @__PURE__ */ __name((businessId, input) => {
+      const vatId = finnishVatId(businessId);
+      return input === null || input.replace(/\s/g, "").toUpperCase() === vatId ? vatId : void 0;
+    }, "vatId")
+  }
+};
+var companyIds = /* @__PURE__ */ __name((country, input) => {
+  const rules = COMPANY_IDS_BY_COUNTRY[country.toUpperCase()] ?? ANY_COUNTRY;
+  const businessId = rules.businessId(input.businessId);
+  if (businessId === null) return {
+    invalid: "businessId"
+  };
+  const vatId = rules.vatId(businessId, input.vatId ?? null);
+  if (vatId === void 0) return {
+    invalid: "vatId"
+  };
+  return {
+    businessId,
+    vatId
+  };
+}, "companyIds");
+
 // ../license-core/src/requestable-products.ts
 var REQUESTABLE_PRODUCTS = [
   "ari",
@@ -174,5 +223,8 @@ export {
   PRODUCTS,
   REQUESTABLE_PRODUCTS,
   USAGE_METRICS,
-  USAGE_METRIC_NAMES
+  USAGE_METRIC_NAMES,
+  companyIds,
+  finnishBusinessId,
+  finnishVatId
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@munchi_oy/license-sdk",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Client for the Munchi license service: cached entitlements and feature checks per venue",
   "type": "module",
   "main": "./dist/index.cjs",