@cocos/pink-types 0.0.0-bootstrap.0 → 0.0.12-beta.1

package/README.md

@@ -1,12 +1,48 @@
 # @cocos/pink-types
 
-Temporary placeholder package. It contains no runtime code or type declarations.
+Public TypeScript type definitions for the PinK extension API (the `pink` module, public tier only).
 
-To publish the first version manually from this directory:
+面向外部插件开发者：仅包含 public 层类型，internal / proposed 层级不随本包发布。
 
-```sh
-npm publish
+## Install
+
+```bash
+npm install @cocos/pink-types
+```
+
+## Prerequisite
+
+`pink.d.ts` references the `vscode` module types — your extension project must install `@types/vscode` (standard for any VS Code extension project):
+
+```bash
+npm install --save-dev @types/vscode
 ```
 
-The package metadata targets the public npm registry and the `bootstrap` dist-tag.
-Publishing requires an npm account with permission to publish under `@cocos`.
+## Usage
+
+Add the package to your `tsconfig.json` types, then import the `pink` module:
+
+```json
+{
+	"compilerOptions": {
+		"types": ["@cocos/pink-types"]
+	}
+}
+```
+
+```typescript
+import * as pink from 'pink';
+
+const assets = await pink.assets.queryAssetInfos();
+const info = await pink.engine.getInfo();
+```
+
+`pink.vscode.d.ts` (PinK-specific augmentations to the VS Code API) is included and referenced automatically via `pink.d.ts`.
+
+## What's not in this package
+
+- **Internal API** (`pink.internal.d.ts`) — for built-in / trusted extensions only.
+- **Proposed API** (`pink.proposed.*.d.ts`) — experimental, opt-in per extension.
+- **`pink-api-schema.json`** — full API schema consumed by the PinK API Lab.
+
+These ship with `@pink/types` (same version, published together) and are not meant for external consumption.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocos/pink-types",
-  "version": "0.0.0-bootstrap.0",
+  "version": "0.0.12-beta.1",
   "description": "Public TypeScript type definitions for the PinK extension API (the `pink` module, public tier only).",
   "license": "MIT",
   "types": "pink.d.ts",
@@ -11,11 +11,10 @@
   ],
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public",
-    "tag": "bootstrap"
+    "access": "public"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/SUD-GLOBAL/PinK"
   }
-}
+}