@meadow-studio/platform 0.0.0-stage → 0.1.0

package/MeadowPlatform.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'MeadowPlatform'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['homepage']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => 'v' + package['version'] }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target = '15.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.9'
+end

package/Package.swift

@@ -0,0 +1,23 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "MeadowPlatform",
+    platforms: [.iOS(.v15)],
+    products: [
+        .library(name: "MeadowPlatform", targets: ["MeadowPlatformPlugin"]),
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0"),
+    ],
+    targets: [
+        .target(
+            name: "MeadowPlatformPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm"),
+            ],
+            path: "ios/Sources/MeadowPlatformPlugin"
+        ),
+    ]
+)

package/README.md

@@ -1,3 +1,148 @@
-# Temporary Holding Version
+# Meadow Platform
 
-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.
+Meadow Platform is an app-production system for moving from an idea to a release-ready Angular
+and Capacitor application quickly and consistently.
+
+It combines a project-creation and adoption CLI, one public npm runtime package, optional capability recipes,
+integration setup, native projects, testing, pull-request CI, diagnostics, and release guardrails.
+Each generated app remains a standalone repository and owns its product, design, credentials, and
+store presence.
+
+```text
+Idea → meadow new (or meadow init) → product work → configure capabilities → CI → release checks → stores
+```
+
+Start with the [Meadow Platform guide](docs/PLATFORM_GUIDE.md). It is the current source for the
+platform mental model, complete capability map, usage workflow, ownership boundaries, and maturity
+limits.
+
+## Create an application
+
+```sh
+meadow new my-app
+```
+
+The generated repository has an app at its root and a static companion website in `website/`.
+The app foundation includes Angular 22, Capacitor 8, iOS and Android projects, Firebase
+dependencies, Vitest, Playwright screenshot testing, GitHub Actions, release documentation, and a
+pinned `@meadow-studio/platform` dependency. RevenueCat and Supabase are optional setup choices. Ionic and
+Meadow Design are not included; they remain app-owned decisions.
+
+Useful next commands include:
+
+```sh
+meadow sync
+meadow add local-data
+meadow add notifications
+meadow configure firebase ...
+meadow doctor
+meadow version patch production
+meadow release-check all
+```
+
+See [the CLI guide](docs/CLI.md) for exact commands and generated behavior.
+
+## Adopt an existing application
+
+In an empty Git checkout containing only `.git`, `meadow init` generates the complete app and
+companion website in place without replacing Git history or its configured remote.
+
+From an existing Angular 22 and Capacitor 8 repository, preview and apply the Meadow control-plane
+foundation without replacing app-owned source, scripts, CI, or instructions:
+
+```sh
+meadow init --dry-run
+meadow init
+```
+
+Initialization infers the app identity and installed providers, creates `meadow.config.json` and a
+companion `website/` project when absent, installs
+the pinned platform and shared provider dependencies, adds narrowly scoped Meadow scripts, and adds a
+managed agent-guidance section pointing at the documentation for the installed platform version.
+It finishes with `meadow doctor`, which makes any remaining differences from the complete generated
+foundation explicit.
+
+## Typed project configuration
+
+`meadow.config.json` v2 is the source of truth for application identity, platforms, devices,
+orientation, release numbers, environments, links, store records, enabled capabilities, public
+provider identifiers, and typed analytics events. After editing it, synchronize generated and
+native project files with:
+
+```sh
+meadow sync
+meadow sync --check
+```
+
+The check form never writes and is included in generated CI. Secrets and deploy-specific values
+remain in ignored environment files or CI secret stores.
+
+## Runtime package
+
+Configure the package once in the Angular root providers:
+
+```ts
+import { provideMeadowPlatform } from '@meadow-studio/platform';
+
+provideMeadowPlatform({
+  app: {
+    name: 'Example App',
+    id: 'app.meadow.example',
+  },
+  environment: 'development',
+  analytics: {
+    enabled: true,
+    allowedEvents: ['item_created'],
+    allowedProperties: ['source'],
+  },
+  crashReporting: { enabled: true },
+  notifications: { enabled: true },
+});
+```
+
+The public runtime currently provides:
+
+- validated, immutable app and environment configuration;
+- native app version, build number, and platform information;
+- provider-neutral analytics with app-owned allowlists, persisted explicit consent, and native
+  Firebase delivery;
+- consent-gated native crash reporting for handled errors and diagnostic breadcrumbs;
+- provider-neutral native purchases with product loading, entitlement state, normalized outcomes,
+  restore, and an app support identifier;
+- provider-neutral local notifications with explicit permission state, schedule/replace/cancel,
+  pending notifications, Android channels, and tap actions;
+- system app-rating requests with shared frequency safeguards; and
+- optional app-build and privacy/support UI through `@meadow-studio/platform/ui`.
+
+The platform deliberately distinguishes complete capabilities from setup foundations. Firebase
+Analytics, Crashlytics, and RevenueCat purchases have Meadow-owned runtime boundaries. Supabase setup
+does not yet constitute a complete Meadow-owned runtime abstraction. See the
+[capability map](docs/PLATFORM_GUIDE.md#current-capability-map) before assuming that an installed
+dependency is an implemented product feature.
+
+## Develop Meadow Platform
+
+```sh
+npm test
+npm run check
+npm run release:check
+```
+
+`npm run check` builds the package, runs tests, creates the real tarball, installs it in a clean
+temporary consumer, type-checks the public API, and exercises the runtime providers.
+
+Released applications pin an exact public npm package version:
+
+```json
+"@meadow-studio/platform": "0.1.0"
+```
+
+See [the release guide](docs/RELEASING.md) for versioning, verification, publishing, and upgrades.
+
+## Documentation
+
+- [Platform guide](docs/PLATFORM_GUIDE.md): current capabilities and how the system is used.
+- [Project brief](docs/PROJECT_BRIEF.md): enduring product and architecture decisions.
+- [CLI guide](docs/CLI.md): exact commands, CI, and generated-app behavior.
+- [POC findings](docs/POC_FINDINGS.md): evidence gathered from real Meadow applications.
+- [v0.1 path](docs/V0.1_PATH.md): historical POC plan and dated implementation record.

package/android/build.gradle

@@ -0,0 +1,42 @@
+ext {
+    capacitorVersion = System.getenv('CAPACITOR_VERSION')
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.1'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.13.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace = "app.meadow.platform"
+    compileSdk = project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
+    defaultConfig {
+        minSdkVersion = project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 24
+        targetSdkVersion = project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 36
+        versionCode = 1
+        versionName = "1.0"
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+dependencies {
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation 'com.google.android.play:review:2.0.2'
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" />

package/android/src/main/java/app/meadow/platform/MeadowAppRatingPlugin.java

@@ -0,0 +1,38 @@
+package app.meadow.platform;
+
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import com.google.android.play.core.review.ReviewInfo;
+import com.google.android.play.core.review.ReviewManager;
+import com.google.android.play.core.review.ReviewManagerFactory;
+
+/** Presents Google Play's unmodified in-app review surface. */
+@CapacitorPlugin(name = "MeadowAppRating")
+public class MeadowAppRatingPlugin extends Plugin {
+    @PluginMethod
+    public void requestReview(PluginCall call) {
+        ReviewManager manager = ReviewManagerFactory.create(getContext());
+        manager.requestReviewFlow().addOnCompleteListener(request -> {
+            if (!request.isSuccessful()) {
+                call.reject("The Play Store review flow is unavailable", request.getException());
+                return;
+            }
+
+            ReviewInfo info = request.getResult();
+            manager.launchReviewFlow(getActivity(), info).addOnCompleteListener(launch -> {
+                if (!launch.isSuccessful()) {
+                    call.reject("The Play Store review flow could not start", launch.getException());
+                    return;
+                }
+
+                // Google deliberately does not report whether a rating was submitted.
+                JSObject result = new JSObject();
+                result.put("attempted", true);
+                call.resolve(result);
+            });
+        });
+    }
+}

package/dist/cli/commands.d.ts

@@ -0,0 +1,74 @@
+import { type MeadowProjectAnswers, type MeadowProjectConfig } from './config.js';
+export interface CommandRunner {
+    run(command: string, args: readonly string[], directory: string): void;
+    succeeds(command: string, args: readonly string[], directory: string): boolean;
+}
+export interface CreateProjectOptions {
+    readonly directory: string;
+    readonly answers: MeadowProjectAnswers;
+    readonly platformVersion: string;
+    readonly platformSpec?: string;
+    readonly install: boolean;
+    readonly git: boolean;
+    readonly visualBaselines: boolean;
+    readonly github?: {
+        readonly owner?: string;
+        readonly visibility: 'private' | 'public' | 'internal';
+    };
+}
+export interface Diagnostic {
+    readonly level: 'pass' | 'warning' | 'failure';
+    readonly id: string;
+    readonly message: string;
+}
+export interface ConfigureOptions {
+    readonly directory: string;
+    readonly values: Readonly<Record<string, string | boolean>>;
+}
+export interface AddOptions {
+    readonly directory: string;
+}
+export interface ExistingProjectInspection {
+    readonly directory: string;
+    readonly answers: MeadowProjectAnswers;
+    readonly angularVersion: string;
+    readonly capacitorVersion: string;
+    readonly packageVersion: string;
+    readonly alreadyInitialized: boolean;
+    readonly warnings: readonly string[];
+}
+export interface InitProjectOptions {
+    readonly directory: string;
+    readonly answers: MeadowProjectAnswers;
+    readonly platformVersion: string;
+    readonly platformSpec?: string;
+    readonly install: boolean;
+    readonly dryRun: boolean;
+}
+export interface InitAction {
+    readonly kind: 'create' | 'update' | 'preserve' | 'run';
+    readonly target: string;
+    readonly detail: string;
+}
+export interface InitProjectResult {
+    readonly config: MeadowProjectConfig;
+    readonly actions: readonly InitAction[];
+    readonly diagnostics: readonly Diagnostic[];
+    readonly changed: boolean;
+}
+export declare const SYSTEM_COMMAND_RUNNER: CommandRunner;
+export declare function createProject(options: CreateProjectOptions, runner?: CommandRunner): string;
+export declare function isCleanGitRepository(directory: string): boolean;
+export declare function initCleanRepository(options: InitProjectOptions & {
+    readonly visualBaselines: boolean;
+}, runner?: CommandRunner): InitProjectResult;
+export declare function writeGeneratedProject(directory: string, files: ReadonlyMap<string, string>): void;
+export declare function inspectExistingProject(directory?: string): ExistingProjectInspection;
+export declare function initProject(options: InitProjectOptions, runner?: CommandRunner): InitProjectResult;
+export declare function configureIntegration(integration: string, options: ConfigureOptions, runner?: CommandRunner): string[];
+export declare function addCapability(capability: string, options: AddOptions, runner?: CommandRunner): string[];
+export declare function doctor(directory?: string): Diagnostic[];
+export declare function releaseCheck(platform: 'ios' | 'android' | 'all', directory?: string, runner?: CommandRunner): Diagnostic[];
+export declare function setApplicationVersion(requested: string, channel: string | undefined, directory?: string): MeadowProjectConfig;
+export declare function nextVersion(current: string, requested: string): string;
+//# sourceMappingURL=commands.d.ts.map

package/dist/cli/commands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAcA,OAAO,EAKL,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACzB,MAAM,aAAa,CAAC;AAmBrB,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACvE,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;CAChF;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAC;IACvC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAChB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,UAAU,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,CAAC;KACxD,CAAC;CACH;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;IAC/C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;CAC7D;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAC;IACvC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC;IACrC,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAC;IACvC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,KAAK,CAAC;IACxD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,CAAC;IACxC,QAAQ,CAAC,WAAW,EAAE,SAAS,UAAU,EAAE,CAAC;IAC5C,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED,eAAO,MAAM,qBAAqB,EAAE,aAYlC,CAAC;AAEH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,oBAAoB,EAC7B,MAAM,GAAE,aAAqC,GAC5C,MAAM,CAoCR;AAED,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAK/D;AAED,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,kBAAkB,GAAG;IAAE,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAA;CAAE,EACnE,MAAM,GAAE,aAAqC,GAC5C,iBAAiB,CA+BnB;AAED,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GACjC,IAAI,CAMN;AAED,wBAAgB,sBAAsB,CAAC,SAAS,SAAgB,GAAG,yBAAyB,CAqF3F;AAED,wBAAgB,WAAW,CACzB,OAAO,EAAE,kBAAkB,EAC3B,MAAM,GAAE,aAAqC,GAC5C,iBAAiB,CAiJnB;AAED,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,gBAAgB,EACzB,MAAM,GAAE,aAAqC,GAC5C,MAAM,EAAE,CAgCV;AAED,wBAAgB,aAAa,CAC3B,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,UAAU,EACnB,MAAM,GAAE,aAAqC,GAC5C,MAAM,EAAE,CASV;AAED,wBAAgB,MAAM,CAAC,SAAS,SAAgB,GAAG,UAAU,EAAE,CAsZ9D;AAED,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,EACnC,SAAS,SAAgB,EACzB,MAAM,GAAE,aAAqC,GAC5C,UAAU,EAAE,CAsCd;AAED,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,SAAS,SAAgB,GACxB,mBAAmB,CAsBrB;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAStE"}