npm - @puzzmo/sdk - Versions diffs - 0.0.1 - Mend

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,230 @@
+# @puzzmo/sdk
+The official Puzzmo SDK for runtime and API access for games.
+## Installation
+### npm
+```bash
+npm install @puzzmo/sdk
+```
+### yarn
+```bash
+yarn add @puzzmo/sdk
+```
+### pnpm
+```bash
+pnpm add @puzzmo/sdk
+```
+## Usage
+### ES Modules (Node.js, Bundlers)
+```javascript
+import { helloWorld, getVersion } from '@puzzmo/sdk'
+console.log(helloWorld()) // "Hello from Puzzmo SDK!"
+console.log(getVersion())  // "0.0.1"
+```
+### CommonJS (Node.js)
+```javascript
+const { helloWorld, getVersion } = require('@puzzmo/sdk')
+console.log(helloWorld()) // "Hello from Puzzmo SDK!"
+console.log(getVersion())  // "0.0.1"
+```
+### UMD (Browser via CDN)
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <script src="https://unpkg.com/@puzzmo/sdk@latest/dist/index.umd.js"></script>
+</head>
+<body>
+  <script>
+    console.log(PuzzmoSDK.helloWorld()) // "Hello from Puzzmo SDK!"
+    console.log(PuzzmoSDK.getVersion())  // "0.0.1"
+  </script>
+</body>
+</html>
+```
+#### Using a specific version
+```html
+<script src="https://unpkg.com/@puzzmo/sdk@0.0.1/dist/index.umd.js"></script>
+```
+#### Using jsDelivr CDN
+```html
+<script src="https://cdn.jsdelivr.net/npm/@puzzmo/sdk@latest/dist/index.umd.js"></script>
+```
+### IIFE (Browser via CDN, smaller build)
+IIFE (Immediately Invoked Function Expression) is a more compact format ideal for modern browsers:
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <script src="https://unpkg.com/@puzzmo/sdk@latest/dist/index.iife.js"></script>
+</head>
+<body>
+  <script>
+    console.log(PuzzmoSDK.helloWorld()) // "Hello from Puzzmo SDK!"
+    console.log(PuzzmoSDK.getVersion())  // "0.0.1"
+  </script>
+</body>
+</html>
+```
+## API Reference
+### `helloWorld(): string`
+Returns a hello world message from the Puzzmo SDK.
+**Returns:** `string` - A greeting message
+**Example:**
+```javascript
+import { helloWorld } from '@puzzmo/sdk'
+const message = helloWorld()
+console.log(message) // "Hello from Puzzmo SDK!"
+```
+### `getVersion(): string`
+Returns the current SDK version.
+**Returns:** `string` - The SDK version
+**Example:**
+```javascript
+import { getVersion } from '@puzzmo/sdk'
+const version = getVersion()
+console.log(version) // "0.0.1"
+```
+## Development
+### Setup
+```bash
+# Install dependencies (from repository root)
+yarn install
+# Build the SDK
+yarn workspace @puzzmo/sdk build
+# Run tests
+yarn workspace @puzzmo/sdk test
+# Watch mode for tests
+yarn workspace @puzzmo/sdk test:watch
+# Type checking
+yarn workspace @puzzmo/sdk type-check
+```
+### Project Structure
+```
+packages/sdk/
+├── src/
+│   └── index.ts          # Main SDK source
+├── dist/                 # Build output (generated)
+│   ├── index.js          # ES module build
+│   ├── index.cjs         # CommonJS build
+│   ├── index.umd.js      # UMD build (for CDN)
+│   ├── index.iife.js     # IIFE build (for CDN, smaller)
+│   └── index.d.ts        # TypeScript declarations
+├── package.json
+├── tsconfig.json
+├── vite.config.ts        # Build configuration
+└── README.md
+```
+### Build Outputs
+The SDK provides multiple build outputs to support different environments:
+- **ESM (`index.js`)**: Modern ES module format for bundlers and modern Node.js
+- **CommonJS (`index.cjs`)**: Traditional CommonJS format for older Node.js environments
+- **UMD (`index.umd.js`)**: Universal Module Definition for browser `<script>` tags via CDN
+- **IIFE (`index.iife.js`)**: Immediately Invoked Function Expression for browser `<script>` tags (smaller than UMD)
+- **TypeScript (`index.d.ts`)**: Type declarations for TypeScript projects
+## Publishing
+The SDK is automatically published to npm when changes are pushed to the `main` branch and the version in `package.json` has been updated.
+### OIDC-Based Publishing
+This package uses **OpenID Connect (OIDC)** for secure, auditable publishing:
+- **Signed Provenance**: Every published version includes cryptographic proof it was built in GitHub Actions
+- **Supply Chain Security**: Verifiable build attestations prevent tampering
+- **Minimal Permissions**: Uses granular npm tokens scoped to this package only
+See [PUBLISHING.md](./PUBLISHING.md) for complete setup instructions and security details.
+### Quick Start: Publishing a New Version
+1. Update the version in `packages/sdk/package.json`:
+   ```bash
+   npm version patch  # or minor/major
+   ```
+2. Commit and push to `main`:
+   ```bash
+   git add package.json
+   git commit -m "chore(sdk): bump version to x.x.x"
+   git push origin main
+   ```
+3. GitHub Actions automatically:
+   - Builds and tests the package
+   - Publishes to npm with OIDC provenance
+   - Creates a git tag for the release
+### Verifying Published Packages
+Anyone can verify the package was built by this repository:
+```bash
+npm view @puzzmo/sdk
+# Look for "provenance" section showing GitHub workflow details
+```
+**Setup Required**: A granular npm access token must be configured as `NPM_TOKEN` in repository secrets. See [PUBLISHING.md](./PUBLISHING.md) for detailed instructions.
+## License
+MIT
+## Contributing
+Contributions are welcome! Please ensure:
+- Tests pass: `yarn workspace @puzzmo/sdk test`
+- Types are correct: `yarn workspace @puzzmo/sdk type-check`
+- Code is formatted: `yarn prettier --write packages/sdk`
+## Support
+For issues and questions, please open an issue on the [GitHub repository](https://github.com/puzzmo-com/games/issues).

package/dist/index.cjs ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function e(){return"Hello from Puzzmo SDK!"}function o(){return"0.0.1"}exports.getVersion=o;exports.helloWorld=e;
2	+ //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["/**\n * Puzzmo SDK\n * Provides runtime and API access for Puzzmo games\n */\n\n/**\n * Returns a hello world message from the Puzzmo SDK\n * @returns A greeting message\n */\nexport function helloWorld(): string {\n return \"Hello from Puzzmo SDK!\"\n}\n\n/**\n * Returns the SDK version\n * @returns The current SDK version\n */\nexport function getVersion(): string {\n return \"0.0.1\"\n}\n"],"names":["helloWorld","getVersion"],"mappings":"gFASO,SAASA,GAAqB,CACnC,MAAO,wBACT,CAMO,SAASC,GAAqB,CACnC,MAAO,OACT"}

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,15 @@
+/**
+ * Puzzmo SDK
+ * Provides runtime and API access for Puzzmo games
+ */
+/**
+ * Returns a hello world message from the Puzzmo SDK
+ * @returns A greeting message
+ */
+export declare function helloWorld(): string;
+/**
+ * Returns the SDK version
+ * @returns The current SDK version
+ */
+export declare function getVersion(): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAEnC;AAED;;;GAGG;AACH,wBAAgB,UAAU,IAAI,MAAM,CAEnC"}

package/dist/index.iife.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ var PuzzmoSDK=function(e){"use strict";function o(){return"Hello from Puzzmo SDK!"}function n(){return"0.0.1"}return e.getVersion=n,e.helloWorld=o,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),e}({});
2	+ //# sourceMappingURL=index.iife.js.map

package/dist/index.iife.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.iife.js","sources":["../src/index.ts"],"sourcesContent":["/**\n * Puzzmo SDK\n * Provides runtime and API access for Puzzmo games\n */\n\n/**\n * Returns a hello world message from the Puzzmo SDK\n * @returns A greeting message\n */\nexport function helloWorld(): string {\n return \"Hello from Puzzmo SDK!\"\n}\n\n/**\n * Returns the SDK version\n * @returns The current SDK version\n */\nexport function getVersion(): string {\n return \"0.0.1\"\n}\n"],"names":["helloWorld","getVersion"],"mappings":"uCASO,SAASA,GAAqB,CACnC,MAAO,wBACT,CAMO,SAASC,GAAqB,CACnC,MAAO,OACT"}

package/dist/index.js ADDED Viewed

@@ -0,0 +1,11 @@
+function o() {
+  return "Hello from Puzzmo SDK!";
+}
+function r() {
+  return "0.0.1";
+}
+export {
+  r as getVersion,
+  o as helloWorld
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["/**\n * Puzzmo SDK\n * Provides runtime and API access for Puzzmo games\n */\n\n/**\n * Returns a hello world message from the Puzzmo SDK\n * @returns A greeting message\n */\nexport function helloWorld(): string {\n return \"Hello from Puzzmo SDK!\"\n}\n\n/**\n * Returns the SDK version\n * @returns The current SDK version\n */\nexport function getVersion(): string {\n return \"0.0.1\"\n}\n"],"names":["helloWorld","getVersion"],"mappings":"AASO,SAASA,IAAqB;AACnC,SAAO;AACT;AAMO,SAASC,IAAqB;AACnC,SAAO;AACT;"}

package/dist/index.umd.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ (function(e,o){typeof exports=="object"&&typeof module!="undefined"?o(exports):typeof define=="function"&&define.amd?define(["exports"],o):(e=typeof globalThis!="undefined"?globalThis:e\|\|self,o(e.PuzzmoSDK={}))})(this,function(e){"use strict";function o(){return"Hello from Puzzmo SDK!"}function n(){return"0.0.1"}e.getVersion=n,e.helloWorld=o,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})});
2	+ //# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.umd.js","sources":["../src/index.ts"],"sourcesContent":["/**\n * Puzzmo SDK\n * Provides runtime and API access for Puzzmo games\n */\n\n/**\n * Returns a hello world message from the Puzzmo SDK\n * @returns A greeting message\n */\nexport function helloWorld(): string {\n return \"Hello from Puzzmo SDK!\"\n}\n\n/**\n * Returns the SDK version\n * @returns The current SDK version\n */\nexport function getVersion(): string {\n return \"0.0.1\"\n}\n"],"names":["helloWorld","getVersion"],"mappings":"mPASO,SAASA,GAAqB,CACnC,MAAO,wBACT,CAMO,SAASC,GAAqB,CACnC,MAAO,OACT"}

package/package.json ADDED Viewed

@@ -0,0 +1,46 @@
+{
+  "name": "@puzzmo/sdk",
+  "version": "0.0.1",
+  "description": "Puzzmo runtime and API access for games",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build && tsc --project tsconfig.build.json",
+    "type-check": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "keywords": [
+    "puzzmo",
+    "games",
+    "sdk"
+  ],
+  "author": "Puzzmo",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/puzzmo-com/games.git",
+    "directory": "packages/sdk"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "typescript": "catalog:",
+    "vite": "catalog:",
+    "vitest": "catalog:"
+  }
+}

@puzzmo/sdk 0.0.1