@northstar-js/contracts 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ali Amaan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/fixtures.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Placeholder fixtures. Display strings use placeholder tokens only; numeric
+ * values are obviously synthetic (zeros and even splits), never plausible results.
+ */
+import type { Distribution, FigureValue, Study } from './index.js';
+export declare const placeholderDistribution: Distribution;
+export interface FigureFixture {
+    figure: FigureValue;
+    /** How the figure would be displayed, in placeholder tokens. */
+    display: string;
+}
+export declare const figures: {
+    readonly level: {
+        readonly figure: {
+            readonly value: 0;
+            readonly band: 0;
+            readonly claim: "level";
+            readonly caption: "[SHARE] ± [BAND] of [N] respondents.";
+            readonly state: "ok";
+        };
+        readonly display: "[SHARE] ± [BAND]";
+    };
+    readonly direction: {
+        readonly figure: {
+            readonly value: 0;
+            readonly claim: "direction";
+            readonly caption: "Direction only; the level is not reported.";
+            readonly state: "ok";
+        };
+        readonly display: "[OPTION] leads";
+    };
+    readonly ranking: {
+        readonly figure: {
+            readonly value: 0;
+            readonly claim: "ranking";
+            readonly caption: "Ranking between items, never the level.";
+            readonly state: "ok";
+        };
+        readonly display: "[OPTION] ranks first of [N]";
+    };
+    readonly withheld: {
+        readonly figure: {
+            readonly value: 0;
+            readonly claim: "level";
+            readonly caption: "Withheld: below the reporting gate.";
+            readonly state: "withheld";
+        };
+        readonly display: "[SHARE]";
+    };
+    readonly stale: {
+        readonly figure: {
+            readonly value: 0;
+            readonly band: 0;
+            readonly claim: "level";
+            readonly caption: "Stale: panel [SEED] has been rebuilt.";
+            readonly state: "stale";
+        };
+        readonly display: "[SHARE] ± [BAND]";
+    };
+};
+export declare const studyAurora: Study;
+export declare const studyBorealis: Study;
+export declare const studyCassiopeia: Study;
+export declare const studyDraco: Study;
+export declare const studies: readonly Study[];
+//# sourceMappingURL=fixtures.d.ts.map

package/dist/fixtures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../src/fixtures.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAInE,eAAO,MAAM,uBAAuB,EAAE,YAGrC,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,WAAW,CAAC;IACpB,gEAAgE;IAChE,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqB8B,CAAC;AAEnD,eAAO,MAAM,WAAW,EAAE,KAUzB,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,KA2B3B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,KAU7B,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,KAQxB,CAAC;AAEF,eAAO,MAAM,OAAO,EAAE,SAAS,KAAK,EAA8D,CAAC"}

package/dist/fixtures.js

@@ -0,0 +1,88 @@
+const ANCHORS = ['[OPTION] 1', '[OPTION] 2', '[OPTION] 3', '[OPTION] 4', '[OPTION] 5'];
+export const placeholderDistribution = {
+    anchors: ANCHORS,
+    shares: [0.2, 0.2, 0.2, 0.2, 0.2],
+};
+export const figures = {
+    level: {
+        figure: { value: 0, band: 0, claim: 'level', caption: '[SHARE] ± [BAND] of [N] respondents.', state: 'ok' },
+        display: '[SHARE] ± [BAND]',
+    },
+    direction: {
+        figure: { value: 0, claim: 'direction', caption: 'Direction only; the level is not reported.', state: 'ok' },
+        display: '[OPTION] leads',
+    },
+    ranking: {
+        figure: { value: 0, claim: 'ranking', caption: 'Ranking between items, never the level.', state: 'ok' },
+        display: '[OPTION] ranks first of [N]',
+    },
+    withheld: {
+        figure: { value: 0, claim: 'level', caption: 'Withheld: below the reporting gate.', state: 'withheld' },
+        display: '[SHARE]',
+    },
+    stale: {
+        figure: { value: 0, band: 0, claim: 'level', caption: 'Stale: panel [SEED] has been rebuilt.', state: 'stale' },
+        display: '[SHARE] ± [BAND]',
+    },
+};
+export const studyAurora = {
+    id: 'study-aurora',
+    title: 'Study Aurora',
+    state: 'draft',
+    tab: 'brief',
+    population: { code: 'FI', size: 0, label: '[N] adults, seed [SEED]' },
+    objectives: ['Screen [OPTION] against [OPTION].'],
+    items: [],
+    createdAt: '2026-01-01T00:00:00.000Z',
+    cost: null,
+};
+export const studyBorealis = {
+    id: 'study-borealis',
+    title: 'Study Borealis',
+    state: 'complete',
+    tab: 'responses',
+    population: { code: 'FI', panelId: 'panel-borealis', size: 0, seed: 0, label: '[N] adults, seed [SEED]' },
+    objectives: ['Rank [OPTION] options for [NAME].'],
+    items: [
+        {
+            key: 'item-1',
+            question: '[NAME]: how much do you agree with [OPTION]?',
+            type: 'mood_direction',
+            format: 'likert',
+            anchors: ANCHORS,
+            result: { distribution: placeholderDistribution, headline: figures.level.figure },
+        },
+        {
+            key: 'item-2',
+            question: '[NAME]: would you choose [OPTION]?',
+            type: 'intention_virtue',
+            format: 'likert',
+            anchors: ANCHORS,
+            result: { distribution: placeholderDistribution, headline: figures.direction.figure },
+        },
+    ],
+    createdAt: '2026-01-01T00:00:00.000Z',
+    cost: { amount: 0, currency: 'EUR', basis: '[COST] per [N] respondents' },
+};
+export const studyCassiopeia = {
+    id: 'study-cassiopeia',
+    title: 'Study Cassiopeia',
+    state: 'running',
+    tab: 'research',
+    population: { code: 'JP', size: 0, label: '[N] adults' },
+    objectives: ['Direction of [OPTION] for [NAME].'],
+    items: [{ key: 'item-1', question: '[NAME]: [OPTION]?', type: 'concrete_habit', anchors: ANCHORS }],
+    createdAt: '2026-01-01T00:00:00.000Z',
+    cost: { amount: 0, currency: 'EUR', basis: '[COST] estimate' },
+};
+export const studyDraco = {
+    id: 'study-draco',
+    title: 'Study Draco',
+    state: 'failed',
+    population: { code: 'US', size: 0 },
+    objectives: [],
+    items: [],
+    createdAt: '2026-01-01T00:00:00.000Z',
+};
+export const studies = [studyAurora, studyBorealis, studyCassiopeia, studyDraco];
+//# sourceMappingURL=fixtures.js.map

package/dist/fixtures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixtures.js","sourceRoot":"","sources":["../src/fixtures.ts"],"names":[],"mappings":"AAMA,MAAM,OAAO,GAAG,CAAC,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;AAEvF,MAAM,CAAC,MAAM,uBAAuB,GAAiB;IACnD,OAAO,EAAE,OAAO;IAChB,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;CAClC,CAAC;AAQF,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,KAAK,EAAE;QACL,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,sCAAsC,EAAE,KAAK,EAAE,IAAI,EAAE;QAC3G,OAAO,EAAE,kBAAkB;KAC5B;IACD,SAAS,EAAE;QACT,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,4CAA4C,EAAE,KAAK,EAAE,IAAI,EAAE;QAC5G,OAAO,EAAE,gBAAgB;KAC1B;IACD,OAAO,EAAE;QACP,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,yCAAyC,EAAE,KAAK,EAAE,IAAI,EAAE;QACvG,OAAO,EAAE,6BAA6B;KACvC;IACD,QAAQ,EAAE;QACR,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,qCAAqC,EAAE,KAAK,EAAE,UAAU,EAAE;QACvG,OAAO,EAAE,SAAS;KACnB;IACD,KAAK,EAAE;QACL,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,uCAAuC,EAAE,KAAK,EAAE,OAAO,EAAE;QAC/G,OAAO,EAAE,kBAAkB;KAC5B;CAC+C,CAAC;AAEnD,MAAM,CAAC,MAAM,WAAW,GAAU;IAChC,EAAE,EAAE,cAAc;IAClB,KAAK,EAAE,cAAc;IACrB,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,OAAO;IACZ,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,yBAAyB,EAAE;IACrE,UAAU,EAAE,CAAC,mCAAmC,CAAC;IACjD,KAAK,EAAE,EAAE;IACT,SAAS,EAAE,0BAA0B;IACrC,IAAI,EAAE,IAAI;CACX,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAU;IAClC,EAAE,EAAE,gBAAgB;IACpB,KAAK,EAAE,gBAAgB;IACvB,KAAK,EAAE,UAAU;IACjB,GAAG,EAAE,WAAW;IAChB,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,yBAAyB,EAAE;IACzG,UAAU,EAAE,CAAC,mCAAmC,CAAC;IACjD,KAAK,EAAE;QACL;YACE,GAAG,EAAE,QAAQ;YACb,QAAQ,EAAE,8CAA8C;YACxD,IAAI,EAAE,gBAAgB;YACtB,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,OAAO;YAChB,MAAM,EAAE,EAAE,YAAY,EAAE,uBAAuB,EAAE,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE;SAClF;QACD;YACE,GAAG,EAAE,QAAQ;YACb,QAAQ,EAAE,oCAAoC;YAC9C,IAAI,EAAE,kBAAkB;YACxB,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,OAAO;YAChB,MAAM,EAAE,EAAE,YAAY,EAAE,uBAAuB,EAAE,QAAQ,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE;SACtF;KACF;IACD,SAAS,EAAE,0BAA0B;IACrC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,4BAA4B,EAAE;CAC1E,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAU;IACpC,EAAE,EAAE,kBAAkB;IACtB,KAAK,EAAE,kBAAkB;IACzB,KAAK,EAAE,SAAS;IAChB,GAAG,EAAE,UAAU;IACf,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE;IACxD,UAAU,EAAE,CAAC,mCAAmC,CAAC;IACjD,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,mBAAmB,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IACnG,SAAS,EAAE,0BAA0B;IACrC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,iBAAiB,EAAE;CAC/D,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAU;IAC/B,EAAE,EAAE,aAAa;IACjB,KAAK,EAAE,aAAa;IACpB,KAAK,EAAE,QAAQ;IACf,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE;IACnC,UAAU,EAAE,EAAE;IACd,KAAK,EAAE,EAAE;IACT,SAAS,EAAE,0BAA0B;CACtC,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAqB,CAAC,WAAW,EAAE,aAAa,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Shared Northstar types. Field names follow the engine
+ * (northstar-engine backend/app/models/schemas.py, services/citizen/studies.py
+ * and population.py), translated to camelCase.
+ */
+/** Lifecycle of a study as the studio shows it. */
+export type StudyState = 'draft' | 'ready' | 'running' | 'complete' | 'partial' | 'failed' | 'archived';
+/** Studio tabs for a study. */
+export type StudyTab = 'brief' | 'population' | 'research' | 'responses';
+/** What a figure may claim: a level, only a direction, or only a ranking. */
+export type ClaimClass = 'level' | 'direction' | 'ranking';
+/** Placeholder tokens used in fixtures and display strings instead of real values. */
+export type PlaceholderToken = '[SHARE]' | '[BAND]' | '[N]' | '[SEED]' | '[OPTION]' | '[COST]' | '[NAME]';
+export declare const PLACEHOLDER_TOKENS: readonly ["[SHARE]", "[BAND]", "[N]", "[SEED]", "[OPTION]", "[COST]", "[NAME]"];
+/** Engine question types (StudyQuestion.question_type), which select the reliability band. */
+export type QuestionType = 'mood_direction' | 'consensus_trust' | 'neutral_factual' | 'concrete_habit' | 'values_identity' | 'intention_virtue';
+/** Engine response formats (StudyQuestion.format). */
+export type ResponseFormat = 'likert' | 'single_choice' | 'multi_select' | 'ranking' | 'free_text' | 'price_trial';
+/** One displayed number. `band` is in percentage points; omit when no defensible band exists. */
+export interface FigureValue {
+    value: number;
+    band?: number;
+    claim?: ClaimClass;
+    /** The sentence that qualifies the figure. */
+    caption?: string;
+    state?: 'ok' | 'withheld' | 'stale';
+}
+/** A Likert or option distribution; `shares[i]` belongs to `anchors[i]`. */
+export interface Distribution {
+    anchors: string[];
+    shares: number[];
+}
+export type MarketStatus = 'roster-ready' | 'covered' | 'registered' | 'none';
+export interface MarketStatusEntry {
+    /** ISO 3166-1 alpha-2 code. */
+    code: string;
+    status: MarketStatus;
+    /** For 'covered': the market whose roster covers this one. */
+    coveredBy?: string;
+}
+/** Estimated run cost, or null when no estimate exists. */
+export type CostEstimate = {
+    amount: number;
+    currency: string;
+    basis: string;
+} | null;
+/** The panel a study runs against (engine PopulationSpec / PanelCreateRequest). */
+export interface PopulationRef {
+    /** Market code, e.g. 'FI'. */
+    code: string;
+    panelId?: string;
+    /** Panel size (engine `count`). */
+    size: number;
+    seed?: number;
+    label?: string;
+}
+/** One question in the battery (engine StudyQuestion). */
+export interface ResearchItem {
+    key: string;
+    question: string;
+    type: QuestionType;
+    format?: ResponseFormat;
+    /** One anchor sentence per Likert step, step 1 first. */
+    anchors?: string[];
+    options?: string[];
+    result?: {
+        distribution: Distribution;
+        headline?: FigureValue;
+    };
+}
+export interface Study {
+    id: string;
+    title: string;
+    state: StudyState;
+    tab?: StudyTab;
+    population: PopulationRef;
+    objectives: string[];
+    items: ResearchItem[];
+    /** ISO 8601 timestamp. */
+    createdAt: string;
+    updatedAt?: string;
+    cost?: CostEstimate;
+}
+/**
+ * Known market statuses. FI and JP have raked rosters, AX is served by the
+ * FI roster, US is registered without a roster (engine population.py).
+ */
+export declare const MARKET_STATUS: {
+    readonly FI: {
+        readonly code: "FI";
+        readonly status: "roster-ready";
+    };
+    readonly JP: {
+        readonly code: "JP";
+        readonly status: "roster-ready";
+    };
+    readonly AX: {
+        readonly code: "AX";
+        readonly status: "covered";
+        readonly coveredBy: "FI";
+    };
+    readonly US: {
+        readonly code: "US";
+        readonly status: "registered";
+    };
+};
+export type KnownMarketCode = keyof typeof MARKET_STATUS;
+/** Status for any market code (case-insensitive); unknown codes are 'none'. */
+export declare function marketStatus(code: string): MarketStatusEntry;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,mDAAmD;AACnD,MAAM,MAAM,UAAU,GAClB,OAAO,GACP,OAAO,GACP,SAAS,GACT,UAAU,GACV,SAAS,GACT,QAAQ,GACR,UAAU,CAAC;AAEf,+BAA+B;AAC/B,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AAEzE,6EAA6E;AAC7E,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,CAAC;AAE3D,sFAAsF;AACtF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE1G,eAAO,MAAM,kBAAkB,iFAQiB,CAAC;AAEjD,8FAA8F;AAC9F,MAAM,MAAM,YAAY,GACpB,gBAAgB,GAChB,iBAAiB,GACjB,iBAAiB,GACjB,gBAAgB,GAChB,iBAAiB,GACjB,kBAAkB,CAAC;AAEvB,sDAAsD;AACtD,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,eAAe,GAAG,cAAc,GAAG,SAAS,GAAG,WAAW,GAAG,aAAa,CAAC;AAEnH,iGAAiG;AACjG,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,IAAI,GAAG,UAAU,GAAG,OAAO,CAAC;CACrC;AAED,4EAA4E;AAC5E,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG,SAAS,GAAG,YAAY,GAAG,MAAM,CAAC;AAE9E,MAAM,WAAW,iBAAiB;IAChC,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,YAAY,CAAC;IACrB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,2DAA2D;AAC3D,MAAM,MAAM,YAAY,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC;AAEtF,mFAAmF;AACnF,MAAM,WAAW,aAAa;IAC5B,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,0DAA0D;AAC1D,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE;QACP,YAAY,EAAE,YAAY,CAAC;QAC3B,QAAQ,CAAC,EAAE,WAAW,CAAC;KACxB,CAAC;CACH;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,UAAU,CAAC;IAClB,GAAG,CAAC,EAAE,QAAQ,CAAC;IACf,UAAU,EAAE,aAAa,CAAC;IAC1B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,YAAY,CAAC;CACrB;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;CAK4B,CAAC;AAEvD,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,aAAa,CAAC;AAEzD,+EAA+E;AAC/E,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAI5D"}

package/dist/index.js

@@ -0,0 +1,31 @@
+/**
+ * Shared Northstar types. Field names follow the engine
+ * (northstar-engine backend/app/models/schemas.py, services/citizen/studies.py
+ * and population.py), translated to camelCase.
+ */
+export const PLACEHOLDER_TOKENS = [
+    '[SHARE]',
+    '[BAND]',
+    '[N]',
+    '[SEED]',
+    '[OPTION]',
+    '[COST]',
+    '[NAME]',
+];
+/**
+ * Known market statuses. FI and JP have raked rosters, AX is served by the
+ * FI roster, US is registered without a roster (engine population.py).
+ */
+export const MARKET_STATUS = {
+    FI: { code: 'FI', status: 'roster-ready' },
+    JP: { code: 'JP', status: 'roster-ready' },
+    AX: { code: 'AX', status: 'covered', coveredBy: 'FI' },
+    US: { code: 'US', status: 'registered' },
+};
+/** Status for any market code (case-insensitive); unknown codes are 'none'. */
+export function marketStatus(code) {
+    const upper = code.trim().toUpperCase();
+    const known = MARKET_STATUS[upper];
+    return known ? { ...known } : { code: upper, status: 'none' };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAqBH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,SAAS;IACT,QAAQ;IACR,KAAK;IACL,QAAQ;IACR,UAAU;IACV,QAAQ;IACR,QAAQ;CACsC,CAAC;AAmFjD;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE;IAC1C,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE;IAC1C,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE;IACtD,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE;CACY,CAAC;AAIvD,+EAA+E;AAC/E,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACxC,MAAM,KAAK,GAAI,aAA+D,CAAC,KAAK,CAAC,CAAC;IACtF,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAChE,CAAC"}

package/package.json

@@ -1,6 +1,45 @@
 {
   "name": "@northstar-js/contracts",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0",
+  "description": "React-free shared types and placeholder fixtures for Northstar packages.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./fixtures": {
+      "types": "./dist/fixtures.d.ts",
+      "import": "./dist/fixtures.js"
+    }
+  },
+  "devDependencies": {
+    "expect-type": "1.2.2",
+    "typescript": "5.9.3",
+    "vitest": "3.2.7"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ali-amaan/northstar-design-system.git",
+    "directory": "packages/contracts"
+  },
+  "homepage": "https://ali-amaan.github.io/northstar-design-system/",
+  "bugs": {
+    "url": "https://github.com/ali-amaan/northstar-design-system/issues"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run --typecheck"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.