@krizaka/org 0.0.0-stage → 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,681 @@
+/** A text in both languages. */
+interface Localized {
+    fr: string;
+    en: string;
+}
+type ProductStatus = "development" | "devPreview";
+interface OrgProduct {
+    id: string;
+    name: string;
+    status: ProductStatus;
+    /** The product's own site. */
+    url: string;
+    /** Its public source repository. */
+    repo: string;
+}
+interface OrgSite {
+    id: string;
+    name: string;
+    url: string;
+}
+interface OrgAvatar {
+    id: string;
+    /** `person` is a silhouette, `plain` a plain disc. */
+    kind: "person" | "plain";
+    svg: string;
+    webp256: string;
+    webp512: string;
+    alt: Localized;
+}
+interface OrgBanner {
+    id: string;
+    /** 1536x512 WebP. */
+    url: string;
+    alt: Localized;
+}
+interface OrgMark {
+    svg: string;
+    png64: string;
+    png256: string;
+    png512: string;
+    png1024: string;
+}
+interface Org {
+    $schema: string;
+    /** The contract: `1` while the shape is the one of `org/v1/org.json`. */
+    schemaVersion: 1;
+    /** The version of `@krizaka/org` that carries this data. */
+    version: string;
+    /** The day the facts were last reviewed (YYYY-MM-DD). */
+    updatedAt: string;
+    company: {
+        legalName: string;
+        tradeName: string;
+        /** Numéro d'entreprise du Québec, already public in the legal footer. */
+        neq: string;
+        city: string;
+        region: string;
+        country: string;
+        license: string;
+        /** « Fait à Montréal ». */
+        madeIn: Localized;
+    };
+    brand: {
+        name: string;
+        logo: {
+            dark: OrgMark;
+            light: OrgMark;
+        };
+        mark: {
+            dark: OrgMark;
+            light: OrgMark;
+        };
+        favicon: string;
+        appleTouchIcon: string;
+        socialPreview: string;
+        manifest: string;
+    };
+    people: {
+        defaults: OrgAvatar[];
+        banners: OrgBanner[];
+    };
+    /** Only the products that are live. */
+    products: OrgProduct[];
+    sites: OrgSite[];
+    contact: {
+        page: Localized;
+        /** The public support address; `null` while none is public. */
+        email: string | null;
+    };
+    footer: {
+        line: Localized;
+        legal: {
+            id: "privacy" | "terms";
+            label: Localized;
+            url: Localized;
+        }[];
+    };
+}
+/** The part of an app's runtime config that depends on the environment. */
+type AppEnvironment = "dev" | "production";
+interface AppConfig {
+    $schema: string;
+    schemaVersion: 1;
+    /** The product this file configures. */
+    app: string;
+    /** The API's base URL per environment; `null` while that environment does not exist. */
+    apiBaseUrl: Record<AppEnvironment, string | null>;
+    /** Feature flags a client may know. */
+    features: Record<string, boolean>;
+    /** The oldest app version the backend still answers (semver). */
+    minAppVersion: string;
+    /** The org file's legal line, so a binary can show it without a network call. */
+    updatedAt: string;
+}
+
+declare const APP_SCHEMA_URL = "https://krizaka-assets.b-cdn.net/org/v1/app.schema.json";
+/** The runtime config a mobile app may know, per live product. The app reads it at start, with a copy built into the binary as fallback. */
+declare const apps: Record<string, AppConfig>;
+
+/** The pull zone that serves the brand files and this JSON. */
+declare const CDN = "https://krizaka-assets.b-cdn.net";
+declare const ORG_URL = "https://krizaka-assets.b-cdn.net/org/v1/org.json";
+declare const ORG_SCHEMA_URL = "https://krizaka-assets.b-cdn.net/org/v1/org.schema.json";
+/** The public facts about Krizaka. Reviewed by pull request; changing a fact is one PR here and a release. */
+declare const org: Org;
+
+/** The JSON Schema of `org/v1/org.json`. Nothing outside it is allowed (`additionalProperties: false` everywhere): a new fact is a new line here first. */
+declare const orgSchema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://krizaka-assets.b-cdn.net/org/v1/org.schema.json";
+    readonly title: "Krizaka organisation — public facts";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["$schema", "schemaVersion", "version", "updatedAt", "company", "brand", "people", "products", "sites", "contact", "footer"];
+    readonly properties: {
+        readonly $schema: {
+            readonly type: "string";
+        };
+        readonly schemaVersion: {
+            readonly const: 1;
+        };
+        readonly version: {
+            readonly type: "string";
+            readonly pattern: "^\\d+\\.\\d+\\.\\d+$";
+        };
+        readonly updatedAt: {
+            readonly type: "string";
+            readonly pattern: "^\\d{4}-\\d{2}-\\d{2}$";
+        };
+        readonly company: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["legalName", "tradeName", "neq", "city", "region", "country", "license", "madeIn"];
+            readonly properties: {
+                readonly legalName: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly tradeName: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly neq: {
+                    readonly type: "string";
+                    readonly pattern: "^\\d{10}$";
+                };
+                readonly city: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly region: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly country: {
+                    readonly type: "string";
+                    readonly pattern: "^[A-Z]{2}$";
+                };
+                readonly license: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly madeIn: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["fr", "en"];
+                    readonly properties: {
+                        readonly fr: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                        readonly en: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                    };
+                };
+            };
+        };
+        readonly brand: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["name", "logo", "mark", "favicon", "appleTouchIcon", "socialPreview", "manifest"];
+            readonly properties: {
+                readonly name: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly logo: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["dark", "light"];
+                    readonly properties: {
+                        readonly dark: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["svg", "png64", "png256", "png512", "png1024"];
+                            readonly properties: {
+                                readonly svg: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png64: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png256: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png512: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png1024: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                            };
+                        };
+                        readonly light: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["svg", "png64", "png256", "png512", "png1024"];
+                            readonly properties: {
+                                readonly svg: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png64: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png256: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png512: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png1024: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                            };
+                        };
+                    };
+                };
+                readonly mark: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["dark", "light"];
+                    readonly properties: {
+                        readonly dark: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["svg", "png64", "png256", "png512", "png1024"];
+                            readonly properties: {
+                                readonly svg: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png64: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png256: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png512: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png1024: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                            };
+                        };
+                        readonly light: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["svg", "png64", "png256", "png512", "png1024"];
+                            readonly properties: {
+                                readonly svg: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png64: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png256: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png512: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                                readonly png1024: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                    readonly pattern: "^https://";
+                                };
+                            };
+                        };
+                    };
+                };
+                readonly favicon: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly pattern: "^https://";
+                };
+                readonly appleTouchIcon: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly pattern: "^https://";
+                };
+                readonly socialPreview: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly pattern: "^https://";
+                };
+                readonly manifest: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly pattern: "^https://";
+                };
+            };
+        };
+        readonly people: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["defaults", "banners"];
+            readonly properties: {
+                readonly defaults: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["id", "kind", "svg", "webp256", "webp512", "alt"];
+                        readonly properties: {
+                            readonly id: {
+                                readonly type: "string";
+                                readonly pattern: "^[a-z0-9]+(-[a-z0-9]+)*$";
+                            };
+                            readonly kind: {
+                                readonly enum: readonly ["person", "plain"];
+                            };
+                            readonly svg: {
+                                readonly type: "string";
+                                readonly format: "uri";
+                                readonly pattern: "^https://";
+                            };
+                            readonly webp256: {
+                                readonly type: "string";
+                                readonly format: "uri";
+                                readonly pattern: "^https://";
+                            };
+                            readonly webp512: {
+                                readonly type: "string";
+                                readonly format: "uri";
+                                readonly pattern: "^https://";
+                            };
+                            readonly alt: {
+                                readonly type: "object";
+                                readonly additionalProperties: false;
+                                readonly required: readonly ["fr", "en"];
+                                readonly properties: {
+                                    readonly fr: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                    };
+                                    readonly en: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                readonly banners: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["id", "url", "alt"];
+                        readonly properties: {
+                            readonly id: {
+                                readonly type: "string";
+                                readonly pattern: "^[a-z0-9]+(-[a-z0-9]+)*$";
+                            };
+                            readonly url: {
+                                readonly type: "string";
+                                readonly format: "uri";
+                                readonly pattern: "^https://";
+                            };
+                            readonly alt: {
+                                readonly type: "object";
+                                readonly additionalProperties: false;
+                                readonly required: readonly ["fr", "en"];
+                                readonly properties: {
+                                    readonly fr: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                    };
+                                    readonly en: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        readonly products: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["id", "name", "status", "url", "repo"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly pattern: "^[a-z0-9]+(-[a-z0-9]+)*$";
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly status: {
+                        readonly enum: readonly ["development", "devPreview"];
+                    };
+                    readonly url: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly pattern: "^https://";
+                    };
+                    readonly repo: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly pattern: "^https://";
+                    };
+                };
+            };
+        };
+        readonly sites: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["id", "name", "url"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly pattern: "^[a-z0-9]+(-[a-z0-9]+)*$";
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly url: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly pattern: "^https://";
+                    };
+                };
+            };
+        };
+        readonly contact: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["page", "email"];
+            readonly properties: {
+                readonly page: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["fr", "en"];
+                    readonly properties: {
+                        readonly fr: {
+                            readonly type: "string";
+                            readonly format: "uri";
+                            readonly pattern: "^https://";
+                        };
+                        readonly en: {
+                            readonly type: "string";
+                            readonly format: "uri";
+                            readonly pattern: "^https://";
+                        };
+                    };
+                };
+                readonly email: {
+                    readonly type: readonly ["string", "null"];
+                    readonly format: "email";
+                };
+            };
+        };
+        readonly footer: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["line", "legal"];
+            readonly properties: {
+                readonly line: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["fr", "en"];
+                    readonly properties: {
+                        readonly fr: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                        readonly en: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                    };
+                };
+                readonly legal: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly items: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["id", "label", "url"];
+                        readonly properties: {
+                            readonly id: {
+                                readonly enum: readonly ["privacy", "terms"];
+                            };
+                            readonly label: {
+                                readonly type: "object";
+                                readonly additionalProperties: false;
+                                readonly required: readonly ["fr", "en"];
+                                readonly properties: {
+                                    readonly fr: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                    };
+                                    readonly en: {
+                                        readonly type: "string";
+                                        readonly minLength: 1;
+                                    };
+                                };
+                            };
+                            readonly url: {
+                                readonly type: "object";
+                                readonly additionalProperties: false;
+                                readonly required: readonly ["fr", "en"];
+                                readonly properties: {
+                                    readonly fr: {
+                                        readonly type: "string";
+                                        readonly format: "uri";
+                                        readonly pattern: "^https://";
+                                    };
+                                    readonly en: {
+                                        readonly type: "string";
+                                        readonly format: "uri";
+                                        readonly pattern: "^https://";
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+};
+/** The JSON Schema of `apps/<product>.json`. */
+declare const appSchema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://krizaka-assets.b-cdn.net/org/v1/app.schema.json";
+    readonly title: "Krizaka mobile app — public runtime config";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["$schema", "schemaVersion", "app", "apiBaseUrl", "features", "minAppVersion", "updatedAt"];
+    readonly properties: {
+        readonly $schema: {
+            readonly type: "string";
+        };
+        readonly schemaVersion: {
+            readonly const: 1;
+        };
+        readonly app: {
+            readonly type: "string";
+            readonly pattern: "^[a-z0-9]+(-[a-z0-9]+)*$";
+        };
+        readonly apiBaseUrl: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["dev", "production"];
+            readonly properties: {
+                readonly dev: {
+                    readonly anyOf: readonly [{
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly pattern: "^https://";
+                    }, {
+                        readonly type: "null";
+                    }];
+                };
+                readonly production: {
+                    readonly anyOf: readonly [{
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly pattern: "^https://";
+                    }, {
+                        readonly type: "null";
+                    }];
+                };
+            };
+        };
+        readonly features: {
+            readonly type: "object";
+            readonly additionalProperties: {
+                readonly type: "boolean";
+            };
+        };
+        readonly minAppVersion: {
+            readonly type: "string";
+            readonly pattern: "^\\d+\\.\\d+\\.\\d+$";
+        };
+        readonly updatedAt: {
+            readonly type: "string";
+            readonly pattern: "^\\d{4}-\\d{2}-\\d{2}$";
+        };
+    };
+};
+
+/** The text of a localized pair for a language (`fr` or `en`; anything else reads English). */
+declare const localized: (text: Localized, locale: string) => string;
+/** The footer line of the family, « Une entreprise de Technologies Krizaka · Fait à Montréal ». */
+declare const footerLine: (locale: string) => string;
+
+export { APP_SCHEMA_URL, type AppConfig, type AppEnvironment, CDN, type Localized, ORG_SCHEMA_URL, ORG_URL, type Org, type OrgAvatar, type OrgBanner, type OrgMark, type OrgProduct, type OrgSite, type ProductStatus, appSchema, apps, footerLine, localized, org, orgSchema };