@krizaka/org
The public facts about Krizaka in one validated JSON that every footer, site and app reads: legal identity, marks, live products, sites, footer line.
Install
npm install @krizaka/orgAlso published as subpath exports: @krizaka/org/org.json, @krizaka/org/org.schema.json, @krizaka/org/apps/*.json.
The public facts about Krizaka, in one validated JSON. The legal name, the NEQ, « Fait à Montréal » in French and English, the brand marks, the default avatars, the live products (Orazaka, Yomizaka, Akinaza), the sites, the public contact, the footer line and the legal links — read by every footer, site and app, so changing one takes one pull request here.
import { footerLine, org } from "@krizaka/org";
footerLine("fr"); // « Une entreprise de Technologies Krizaka · Fait à Montréal »
org.company.legalName; // « Technologies Krizaka Inc. »Without a build step, read it from the CDN: krizaka-assets.b-cdn.net/org/v1/org.json (an immutable copy sits beside it,
org.<hash>.json). Also exported: @krizaka/org/org.json, @krizaka/org/org.schema.json and @krizaka/org/apps/<product>.json.
- Public facts only. Never an address, a phone number, figures, a secret, an IP address or an internal host: the test scans for them and the schema refuses any field it does not list.
- Validated.
orgSchema(JSON Schema 2020-12) and the typesOrg,AppConfig…; a test validates the data and requests every URL in it. - Mobile runtime config.
apps/<product>.jsonholds what a client may know — the API base URL per environment, feature flags, the minimum app version — never a secret. An app reads it at start, with a copy built into the binary as fallback. - Published on each release by the Release workflow (
pnpm run publish:cdn), needing the organisation secretsMEDIA_STORAGE_API_KEYandMEDIA_STORAGE_ZONE; without them it warns and publishes nothing.
Apache-2.0 · Krizaka TypeScript
Exports
The 20 names the package exports, read from its types.
| Name | Kind | What it is |
|---|---|---|
APP_SCHEMA_URL | constant | |
AppConfig | type | |
AppEnvironment | type | The part of an app's runtime config that depends on the environment. |
apps | constant | The runtime config a mobile app may know, per live product. |
appSchema | constant | The JSON Schema of apps/<product>.json. |
CDN | constant | The pull zone that serves the brand files and this JSON. |
footerLine | function | The footer line of the family, « Une entreprise de Technologies Krizaka · Fait à Montréal ». |
localized | function | The text of a localized pair for a language (fr or en; anything else reads English). |
Localized | type | A text in both languages. |
org | constant | The public facts about Krizaka. |
Org | type | |
ORG_SCHEMA_URL | constant | |
ORG_URL | constant | |
OrgAvatar | type | |
OrgBanner | type | |
OrgMark | type | |
OrgProduct | type | |
orgSchema | constant | The JSON Schema of org/v1/org.json. |
OrgSite | type | |
ProductStatus | type |
@krizaka/org/org.json
| Name | Kind | What it is |
|---|
@krizaka/org/org.schema.json
| Name | Kind | What it is |
|---|
@krizaka/org/apps/*.json
| Name | Kind | What it is |
|---|
Package
Changelog
0.1.0
Minor changes
- First release: the public facts about Krizaka in one validated JSON (company, brand, default avatars, live products, sites, contact, footer line), its JSON Schema and types, the mobile apps' public runtime config, and the CDN publish of
org/v1/org.json.