@playporter/core 0.1.0

package/README.md

@@ -0,0 +1,3 @@
+# @playporter/core
+
+Shared PlayPorter contracts, types and core models used by the SDK and Studio.

package/dist/index.d.ts

@@ -0,0 +1,188 @@
+export declare const SUPPORTED_PLATFORMS: readonly ["discord", "telegram", "reddit", "web"];
+export type Platform = (typeof SUPPORTED_PLATFORMS)[number];
+export type PublicPlatform = Exclude<Platform, "web">;
+export type EnvironmentName = "development" | "staging" | "production";
+export type PlanName = "free" | "pro" | "business";
+export interface PlanLimits {
+    games: number;
+    monthlyActivePlayers: number;
+    monthlyEvents: number;
+    analyticsRetentionDays: number;
+    liveOpsFlags: number;
+    collaborators: number;
+    environments: EnvironmentName[];
+    platforms: PublicPlatform[];
+    branded: boolean;
+}
+export declare const PLAN_LIMITS: Record<PlanName, PlanLimits>;
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export interface PlayerProfile {
+    id: string;
+    displayName?: string | null;
+    avatarUrl?: string | null;
+    platform: Platform;
+    platformUserId: string;
+    isGuest: boolean;
+}
+export interface FeatureFlagDefinition {
+    key: string;
+    enabled: boolean;
+    value: JsonValue;
+    rolloutPercentage: number;
+    platforms?: Platform[];
+    minimumVersion?: string | null;
+    maximumVersion?: string | null;
+}
+export interface EffectiveConfig {
+    environment: EnvironmentName;
+    revision: number;
+    values: Record<string, JsonValue>;
+    flags: Record<string, JsonValue>;
+    fetchedAt: string;
+}
+export interface AnalyticsEventInput {
+    name: string;
+    occurredAt?: string;
+    sessionId?: string;
+    properties?: Record<string, JsonValue>;
+}
+export interface ValidationIssue {
+    code: string;
+    severity: "error" | "warning" | "info";
+    platform: Platform | "common";
+    message: string;
+    file?: string;
+    remediation?: string;
+}
+export interface ValidationReportData {
+    id?: string;
+    bundlePath: string;
+    bundleHash: string;
+    createdAt: string;
+    totalBytes: number;
+    fileCount: number;
+    platforms: PublicPlatform[];
+    issues: ValidationIssue[];
+    passed: boolean;
+}
+export interface ArtifactFileEntry {
+    path: string;
+    bytes: number;
+    sha256: string;
+    role: "entry" | "asset" | "runtime" | "metadata";
+}
+export interface ArtifactManifest {
+    schemaVersion: 1;
+    artifactId: string;
+    game: PlayPorterConfig["game"];
+    createdAt: string;
+    builder: {
+        cliVersion: string;
+        nodeVersion: string;
+        platform: string;
+    };
+    bundle: {
+        root: string;
+        entry: string;
+        totalBytes: number;
+        fileCount: number;
+        sha256: string;
+    };
+    validation: {
+        passed: boolean;
+        platforms: PublicPlatform[];
+        issueCount: number;
+    };
+    claims: {
+        sourceCodeIncluded: false;
+        localCompilation: true;
+        studioControlledRelease: true;
+    };
+    files: ArtifactFileEntry[];
+}
+export interface ArtifactSignature {
+    algorithm: "ed25519";
+    publicKeyPem: string;
+    signatureBase64: string;
+    signedAt: string;
+    manifestSha256: string;
+}
+export interface PassportAccount {
+    platform: Platform;
+    username?: string | null;
+    displayName?: string | null;
+    externalId: string;
+    verifiedAt?: string;
+}
+export interface PassportSummary {
+    player: PlayerProfile;
+    passportId: string;
+    linkedAccounts: PassportAccount[];
+    profile: Record<string, JsonValue>;
+    achievements: Array<{
+        id: string;
+        unlockedAt: string;
+        metadata?: Record<string, JsonValue>;
+    }>;
+    purchases: Array<{
+        id: string;
+        sku: string;
+        purchasedAt: string;
+        metadata?: Record<string, JsonValue>;
+    }>;
+    friends: Array<{
+        id: string;
+        displayName?: string | null;
+        platform?: Platform;
+        linkedAt: string;
+    }>;
+    preferences: Record<string, JsonValue>;
+    saveKeys: string[];
+    leaderboardEntries: Array<{
+        leaderboard: string;
+        score: number;
+        updatedAt: string;
+    }>;
+}
+export interface PlayPorterConfig {
+    schemaVersion: 1;
+    game: {
+        id?: string;
+        slug: string;
+        name: string;
+        version: string;
+    };
+    build: {
+        command: string;
+        output: string;
+    };
+    api: {
+        baseUrl: string;
+        projectKeyEnv: string;
+    };
+    platforms: {
+        discord?: {
+            enabled: boolean;
+            clientId?: string;
+            urlMappings?: Array<{
+                prefix: string;
+                target: string;
+            }>;
+        };
+        telegram?: {
+            enabled: boolean;
+            botUsername?: string;
+        };
+        reddit?: {
+            enabled: boolean;
+            appName?: string;
+            subreddit?: string;
+            postTitle?: string;
+        };
+    };
+}
+export declare function deterministicBucket(...parts: string[]): number;
+export declare function compareSemver(left: string, right: string): number;

package/dist/index.js

@@ -0,0 +1,58 @@
+export const SUPPORTED_PLATFORMS = ["discord", "telegram", "reddit", "web"];
+export const PLAN_LIMITS = {
+    free: {
+        games: 1,
+        monthlyActivePlayers: 2_500,
+        monthlyEvents: 50_000,
+        analyticsRetentionDays: 7,
+        liveOpsFlags: 10,
+        collaborators: 1,
+        environments: ["development", "production"],
+        platforms: ["discord", "telegram", "reddit"],
+        branded: true,
+    },
+    pro: {
+        games: 10,
+        monthlyActivePlayers: 100_000,
+        monthlyEvents: 5_000_000,
+        analyticsRetentionDays: 90,
+        liveOpsFlags: 250,
+        collaborators: 10,
+        environments: ["development", "staging", "production"],
+        platforms: ["discord", "telegram", "reddit"],
+        branded: false,
+    },
+    business: {
+        games: Number.MAX_SAFE_INTEGER,
+        monthlyActivePlayers: Number.MAX_SAFE_INTEGER,
+        monthlyEvents: Number.MAX_SAFE_INTEGER,
+        analyticsRetentionDays: 365,
+        liveOpsFlags: Number.MAX_SAFE_INTEGER,
+        collaborators: Number.MAX_SAFE_INTEGER,
+        environments: ["development", "staging", "production"],
+        platforms: ["discord", "telegram", "reddit"],
+        branded: false,
+    },
+};
+export function deterministicBucket(...parts) {
+    const input = parts.join(":");
+    let hash = 2166136261;
+    for (let index = 0; index < input.length; index += 1) {
+        hash ^= input.charCodeAt(index);
+        hash = Math.imul(hash, 16777619);
+    }
+    return (hash >>> 0) % 100;
+}
+export function compareSemver(left, right) {
+    const parse = (value) => value.split(".").map((part) => Number.parseInt(part, 10) || 0);
+    const a = parse(left);
+    const b = parse(right);
+    const length = Math.max(a.length, b.length);
+    for (let index = 0; index < length; index += 1) {
+        const difference = (a[index] ?? 0) - (b[index] ?? 0);
+        if (difference !== 0)
+            return difference;
+    }
+    return 0;
+}
+//# 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,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,CAAU,CAAC;AAkBrF,MAAM,CAAC,MAAM,WAAW,GAAiC;IACvD,IAAI,EAAE;QACJ,KAAK,EAAE,CAAC;QACR,oBAAoB,EAAE,KAAK;QAC3B,aAAa,EAAE,MAAM;QACrB,sBAAsB,EAAE,CAAC;QACzB,YAAY,EAAE,EAAE;QAChB,aAAa,EAAE,CAAC;QAChB,YAAY,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC;QAC3C,SAAS,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC;QAC5C,OAAO,EAAE,IAAI;KACd;IACD,GAAG,EAAE;QACH,KAAK,EAAE,EAAE;QACT,oBAAoB,EAAE,OAAO;QAC7B,aAAa,EAAE,SAAS;QACxB,sBAAsB,EAAE,EAAE;QAC1B,YAAY,EAAE,GAAG;QACjB,aAAa,EAAE,EAAE;QACjB,YAAY,EAAE,CAAC,aAAa,EAAE,SAAS,EAAE,YAAY,CAAC;QACtD,SAAS,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC;QAC5C,OAAO,EAAE,KAAK;KACf;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,MAAM,CAAC,gBAAgB;QAC9B,oBAAoB,EAAE,MAAM,CAAC,gBAAgB;QAC7C,aAAa,EAAE,MAAM,CAAC,gBAAgB;QACtC,sBAAsB,EAAE,GAAG;QAC3B,YAAY,EAAE,MAAM,CAAC,gBAAgB;QACrC,aAAa,EAAE,MAAM,CAAC,gBAAgB;QACtC,YAAY,EAAE,CAAC,aAAa,EAAE,SAAS,EAAE,YAAY,CAAC;QACtD,SAAS,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC;QAC5C,OAAO,EAAE,KAAK;KACf;CACF,CAAC;AAiKF,MAAM,UAAU,mBAAmB,CAAC,GAAG,KAAe;IACpD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,IAAI,GAAG,UAAU,CAAC;IACtB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACrD,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,GAAG,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,KAAa;IACvD,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAChG,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IACtB,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IAC5C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QACrD,IAAI,UAAU,KAAK,CAAC;YAAE,OAAO,UAAU,CAAC;IAC1C,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC"}

package/dist/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.test.js

@@ -0,0 +1,17 @@
+import test from "node:test";
+import assert from "node:assert/strict";
+import { compareSemver, deterministicBucket, PLAN_LIMITS } from "./index.js";
+test("deterministicBucket is stable and bounded", () => {
+    const first = deterministicBucket("player-1", "weekend_event");
+    assert.equal(first, deterministicBucket("player-1", "weekend_event"));
+    assert.ok(first >= 0 && first < 100);
+});
+test("compareSemver compares numeric segments", () => {
+    assert.equal(compareSemver("1.2.0", "1.2"), 0);
+    assert.ok(compareSemver("1.10.0", "1.2.9") > 0);
+    assert.ok(compareSemver("2.0.0", "2.1.0") < 0);
+});
+test("free plan includes all three launch platforms", () => {
+    assert.deepEqual(PLAN_LIMITS.free.platforms, ["discord", "telegram", "reddit"]);
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE7E,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;IACrD,MAAM,KAAK,GAAG,mBAAmB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;IAC/D,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,mBAAmB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC;IACtE,MAAM,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,GAAG,CAAC,CAAC;AACvC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,yCAAyC,EAAE,GAAG,EAAE;IACnD,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/C,MAAM,CAAC,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,MAAM,CAAC,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;AACjD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;IACzD,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;AAClF,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@playporter/core",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "package.json",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "node --test dist/**/*.test.js",
+    "prepublishOnly": "npm run build && npm run typecheck"
+  }
+}