@agentrules/core 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -215,6 +215,11 @@ declare const PLATFORMS: {
         readonly project: "{platformDir}/tool/{name}.ts";
         readonly global: "{platformDir}/tool/{name}.ts";
       };
+      readonly skill: {
+        readonly description: "Agent skill";
+        readonly project: "{platformDir}/skill/{name}/SKILL.md";
+        readonly global: "{platformDir}/skill/{name}/SKILL.md";
+      };
     };
   };
   readonly claude: {
@@ -264,6 +269,11 @@ declare const PLATFORMS: {
         readonly project: "{platformDir}/commands/{name}.md";
         readonly global: "{platformDir}/commands/{name}.md";
       };
+      readonly skill: {
+        readonly description: "Agent skill";
+        readonly project: "{platformDir}/skills/{name}/SKILL.md";
+        readonly global: "{platformDir}/skills/{name}/SKILL.md";
+      };
     };
   };
   readonly codex: {
@@ -281,6 +291,11 @@ declare const PLATFORMS: {
         readonly project: null;
         readonly global: "{platformDir}/prompts/{name}.md";
       };
+      readonly skill: {
+        readonly description: "Agent skill";
+        readonly project: "{platformDir}/skills/{name}/SKILL.md";
+        readonly global: "{platformDir}/skills/{name}/SKILL.md";
+      };
     };
   };
 };
@@ -316,15 +331,28 @@ declare function getInstallPath({
 }: GetInstallPathInput): string | null;
 /** Get platform configuration */
 declare function getPlatformConfig(platform: PlatformId): PlatformConfig;
+/**
+ * Get the relative install path for a type (without the root directory prefix).
+ * Returns the path relative to the platform's root directory.
+ *
+ * Example: For codex instruction with scope="global", returns "AGENTS.md"
+ * (not "~/.codex/AGENTS.md")
+ */
+declare function getRelativeInstallPath({
+  platform,
+  type,
+  name,
+  scope
+}: GetInstallPathInput): string | null;
 /**
  * Platform-specific type tuples for zod schema validation.
  * Must be kept in sync with PLATFORMS types above.
  */
 declare const PLATFORM_RULE_TYPES: {
-  readonly opencode: readonly ["instruction", "agent", "command", "tool"];
+  readonly opencode: readonly ["instruction", "agent", "command", "tool", "skill"];
   readonly claude: readonly ["instruction", "rule", "command", "skill"];
-  readonly cursor: readonly ["instruction", "rule", "command"];
-  readonly codex: readonly ["instruction", "command"];
+  readonly cursor: readonly ["instruction", "rule", "command", "skill"];
+  readonly codex: readonly ["instruction", "command", "skill"];
 };
 
 //#endregion
@@ -357,6 +385,36 @@ declare function inferInstructionPlatformsFromFileName(fileName: string): Platfo
  * Uses PLATFORMS templates as source-of-truth.
  */
 declare function inferTypeFromPath(platform: PlatformId, filePath: string): string | undefined;
+type GetInstallDirInput = {
+  platform: PlatformId;
+  type: string;
+  name: string;
+};
+/**
+ * Get the install directory for a type (parent directory of the install path).
+ * For skills, this is the directory containing SKILL.md.
+ */
+declare function getInstallDir({
+  platform,
+  type,
+  name
+}: GetInstallDirInput): string | null;
+type BundleFile = {
+  path: string;
+  content: string | Uint8Array;
+};
+type NormalizeSkillFilesInput = {
+  files: BundleFile[];
+  installDir: string;
+};
+/**
+ * Normalize skill files by finding SKILL.md anchor and adjusting all paths.
+ * Strips any existing path prefix to prevent duplication.
+ */
+declare function normalizeSkillFiles({
+  files,
+  installDir
+}: NormalizeSkillFilesInput): BundleFile[];
 
 //#endregion
 //#region src/resolve/types.d.ts
@@ -453,11 +511,11 @@ declare const licenseSchema: z.ZodString;
  */
 declare const ruleTypeSchema: z.ZodEnum<{
   instruction: "instruction";
-  rule: "rule";
-  command: "command";
-  skill: "skill";
   agent: "agent";
+  command: "command";
   tool: "tool";
+  skill: "skill";
+  rule: "rule";
 }>;
 /**
  * Rule config schema.
@@ -472,11 +530,11 @@ declare const ruleConfigSchema: z.ZodObject<{
   name: z.ZodString;
   type: z.ZodOptional<z.ZodEnum<{
     instruction: "instruction";
-    rule: "rule";
-    command: "command";
-    skill: "skill";
     agent: "agent";
+    command: "command";
     tool: "tool";
+    skill: "skill";
+    rule: "rule";
   }>>;
   title: z.ZodString;
   version: z.ZodOptional<z.ZodNumber>;
@@ -539,11 +597,11 @@ declare const rulePublishInputSchema: z.ZodObject<{
   name: z.ZodString;
   type: z.ZodOptional<z.ZodEnum<{
     instruction: "instruction";
-    rule: "rule";
-    command: "command";
-    skill: "skill";
     agent: "agent";
+    command: "command";
     tool: "tool";
+    skill: "skill";
+    rule: "rule";
   }>>;
   title: z.ZodString;
   description: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -577,11 +635,11 @@ declare const ruleBundleSchema: z.ZodObject<{
   name: z.ZodString;
   type: z.ZodOptional<z.ZodEnum<{
     instruction: "instruction";
-    rule: "rule";
-    command: "command";
-    skill: "skill";
     agent: "agent";
+    command: "command";
     tool: "tool";
+    skill: "skill";
+    rule: "rule";
   }>>;
   platform: z.ZodEnum<{
     opencode: "opencode";
@@ -947,4 +1005,4 @@ declare function toUint8Array(payload: ArrayBuffer | ArrayBufferView): Uint8Arra
 declare function normalizeBundlePath(value: string): string;
 
 //#endregion
-export { API_ENDPOINTS, BuildPublishInputOptions, BuildRegistryOptions, BuildRegistryResult, BundledFile, COMMON_LICENSES, CommonLicense, DiffPreviewOptions, GetInstallPathInput, InstallScope, LATEST_VERSION, PLATFORMS, PLATFORM_IDS, PLATFORM_ID_TUPLE, PLATFORM_RULE_TYPES, PlatformConfig, PlatformEntry, PlatformFiles, PlatformId, PlatformRuleType, PublishVariantInput, RULE_CONFIG_FILENAME, RULE_SCHEMA_URL, RULE_TYPE_TUPLE, RawPlatformEntry, RawRuleConfig, ResolveResponse, ResolvedRule, RuleBundle, RuleConfig, RuleFileInput, RuleInput, RulePublishInput, RuleType, RuleTypeForPlatform, RuleValidationResult, RuleVariant, RuleVersion, STATIC_BUNDLE_DIR, SupportsInstallPathInput, TypeConfig, buildPublishInput, buildRegistry, bundledFileSchema, cleanInstallMessage, createDiffPreview, decodeBundledFile, decodeUtf8, descriptionSchema, encodeUtf8, fetchBundle, getInstallPath, getLatestVersion, getPlatformConfig, getPlatformFromDir, getPlatforms, getTypeConfig, getValidTypes, getVariant, getVersion, hasBundle, hasInlineContent, hasPlatform, inferInstructionPlatformsFromFileName, inferPlatformFromPath, inferTypeFromPath, isLikelyText, isPlatformDir, isSupportedPlatform, isValidType, licenseSchema, nameSchema, normalizeBundlePath, normalizePlatformEntry, normalizePlatformInput, platformIdSchema, publishVariantInputSchema, resolveResponseSchema, resolveSlug, resolvedRuleSchema, ruleBundleSchema, ruleConfigSchema, rulePublishInputSchema, ruleTypeSchema, ruleVariantSchema, ruleVersionSchema, supportsInstallPath, tagSchema, tagsSchema, titleSchema, toPosixPath, toUint8Array, toUtf8String, validateConfig, validateRule, verifyBundledFileChecksum };
+export { API_ENDPOINTS, BuildPublishInputOptions, BuildRegistryOptions, BuildRegistryResult, BundleFile, BundledFile, COMMON_LICENSES, CommonLicense, DiffPreviewOptions, GetInstallDirInput, GetInstallPathInput, InstallScope, LATEST_VERSION, NormalizeSkillFilesInput, PLATFORMS, PLATFORM_IDS, PLATFORM_ID_TUPLE, PLATFORM_RULE_TYPES, PlatformConfig, PlatformEntry, PlatformFiles, PlatformId, PlatformRuleType, PublishVariantInput, RULE_CONFIG_FILENAME, RULE_SCHEMA_URL, RULE_TYPE_TUPLE, RawPlatformEntry, RawRuleConfig, ResolveResponse, ResolvedRule, RuleBundle, RuleConfig, RuleFileInput, RuleInput, RulePublishInput, RuleType, RuleTypeForPlatform, RuleValidationResult, RuleVariant, RuleVersion, STATIC_BUNDLE_DIR, SupportsInstallPathInput, TypeConfig, buildPublishInput, buildRegistry, bundledFileSchema, cleanInstallMessage, createDiffPreview, decodeBundledFile, decodeUtf8, descriptionSchema, encodeUtf8, fetchBundle, getInstallDir, getInstallPath, getLatestVersion, getPlatformConfig, getPlatformFromDir, getPlatforms, getRelativeInstallPath, getTypeConfig, getValidTypes, getVariant, getVersion, hasBundle, hasInlineContent, hasPlatform, inferInstructionPlatformsFromFileName, inferPlatformFromPath, inferTypeFromPath, isLikelyText, isPlatformDir, isSupportedPlatform, isValidType, licenseSchema, nameSchema, normalizeBundlePath, normalizePlatformEntry, normalizePlatformInput, normalizeSkillFiles, platformIdSchema, publishVariantInputSchema, resolveResponseSchema, resolveSlug, resolvedRuleSchema, ruleBundleSchema, ruleConfigSchema, rulePublishInputSchema, ruleTypeSchema, ruleVariantSchema, ruleVersionSchema, supportsInstallPath, tagSchema, tagsSchema, titleSchema, toPosixPath, toUint8Array, toUtf8String, validateConfig, validateRule, verifyBundledFileChecksum };

package/dist/index.js

@@ -52,6 +52,11 @@ const PLATFORMS = {
 				description: "Custom tool",
 				project: "{platformDir}/tool/{name}.ts",
 				global: "{platformDir}/tool/{name}.ts"
+			},
+			skill: {
+				description: "Agent skill",
+				project: "{platformDir}/skill/{name}/SKILL.md",
+				global: "{platformDir}/skill/{name}/SKILL.md"
 			}
 		}
 	},
@@ -101,6 +106,11 @@ const PLATFORMS = {
 				description: "Custom slash command",
 				project: "{platformDir}/commands/{name}.md",
 				global: "{platformDir}/commands/{name}.md"
+			},
+			skill: {
+				description: "Agent skill",
+				project: "{platformDir}/skills/{name}/SKILL.md",
+				global: "{platformDir}/skills/{name}/SKILL.md"
 			}
 		}
 	},
@@ -118,6 +128,11 @@ const PLATFORMS = {
 				description: "Custom prompt",
 				project: null,
 				global: "{platformDir}/prompts/{name}.md"
+			},
+			skill: {
+				description: "Agent skill",
+				project: "{platformDir}/skills/{name}/SKILL.md",
+				global: "{platformDir}/skills/{name}/SKILL.md"
 			}
 		}
 	}
@@ -156,6 +171,21 @@ function getPlatformConfig(platform) {
 	return PLATFORMS[platform];
 }
 /**
+* Get the relative install path for a type (without the root directory prefix).
+* Returns the path relative to the platform's root directory.
+*
+* Example: For codex instruction with scope="global", returns "AGENTS.md"
+* (not "~/.codex/AGENTS.md")
+*/
+function getRelativeInstallPath({ platform, type, name, scope = "project" }) {
+	const typeConfig = getTypeConfig(platform, type);
+	if (!typeConfig) return null;
+	const template = scope === "project" ? typeConfig.project : typeConfig.global;
+	if (!template) return null;
+	if (template.includes("{name}") && !name) throw new Error(`Missing name for install path: platform="${platform}" type="${type}" scope="${scope}"`);
+	return template.replace("{platformDir}/", "").replace("{platformDir}", "").replace("{name}", name ?? "");
+}
+/**
 * Platform-specific type tuples for zod schema validation.
 * Must be kept in sync with PLATFORMS types above.
 */
@@ -164,7 +194,8 @@ const PLATFORM_RULE_TYPES = {
 		"instruction",
 		"agent",
 		"command",
-		"tool"
+		"tool",
+		"skill"
 	],
 	claude: [
 		"instruction",
@@ -175,9 +206,14 @@ const PLATFORM_RULE_TYPES = {
 	cursor: [
 		"instruction",
 		"rule",
-		"command"
+		"command",
+		"skill"
 	],
-	codex: ["instruction", "command"]
+	codex: [
+		"instruction",
+		"command",
+		"skill"
+	]
 };
 
 //#endregion
@@ -274,6 +310,41 @@ function inferTypeFromPath(platform, filePath) {
 	if (!nextDir) return;
 	return getProjectTypeDirMap(platform).get(nextDir);
 }
+/**
+* Get the install directory for a type (parent directory of the install path).
+* For skills, this is the directory containing SKILL.md.
+*/
+function getInstallDir({ platform, type, name }) {
+	const installPath = getInstallPath({
+		platform,
+		type,
+		name,
+		scope: "project"
+	});
+	if (!installPath) return null;
+	const lastSlash = installPath.lastIndexOf("/");
+	if (lastSlash === -1) return null;
+	return installPath.slice(0, lastSlash);
+}
+/**
+* Normalize skill files by finding SKILL.md anchor and adjusting all paths.
+* Strips any existing path prefix to prevent duplication.
+*/
+function normalizeSkillFiles({ files, installDir }) {
+	const marker = files.find((f) => f.path === "SKILL.md" || f.path.endsWith("/SKILL.md"));
+	if (!marker) throw new Error("SKILL.md not found in files");
+	const skillRoot = marker.path === "SKILL.md" ? "." : marker.path.slice(0, marker.path.lastIndexOf("/"));
+	return files.map((f) => {
+		let relative;
+		if (skillRoot === ".") relative = f.path;
+		else if (f.path.startsWith(`${skillRoot}/`)) relative = f.path.slice(skillRoot.length + 1);
+		else relative = f.path;
+		return {
+			...f,
+			path: `${installDir}/${relative}`
+		};
+	});
+}
 
 //#endregion
 //#region src/utils/encoding.ts
@@ -674,7 +745,7 @@ function normalizeBundleBase(base) {
 }
 function getBundlePath(base, slug, platform, version) {
 	const prefix = base ? `${base}/` : "";
-	return `${prefix}${STATIC_BUNDLE_DIR}/${slug}/${platform}/${version}`;
+	return `${prefix}${STATIC_BUNDLE_DIR}/${slug}/${version}/${platform}.json`;
 }
 function ensureKnownPlatform(platform, slug) {
 	if (!isSupportedPlatform(platform)) throw new Error(`Unknown platform "${platform}" in ${slug}. Supported: ${PLATFORM_IDS.join(", ")}`);
@@ -892,4 +963,4 @@ function normalizeBundlePath(value) {
 }
 
 //#endregion
-export { API_ENDPOINTS, COMMON_LICENSES, LATEST_VERSION, PLATFORMS, PLATFORM_IDS, PLATFORM_ID_TUPLE, PLATFORM_RULE_TYPES, RULE_CONFIG_FILENAME, RULE_SCHEMA_URL, RULE_TYPE_TUPLE, STATIC_BUNDLE_DIR, buildPublishInput, buildRegistry, bundledFileSchema, cleanInstallMessage, createDiffPreview, decodeBundledFile, decodeUtf8, descriptionSchema, encodeUtf8, fetchBundle, getInstallPath, getLatestVersion, getPlatformConfig, getPlatformFromDir, getPlatforms, getTypeConfig, getValidTypes, getVariant, getVersion, hasBundle, hasInlineContent, hasPlatform, inferInstructionPlatformsFromFileName, inferPlatformFromPath, inferTypeFromPath, isLikelyText, isPlatformDir, isSupportedPlatform, isValidType, licenseSchema, nameSchema, normalizeBundlePath, normalizePlatformEntry, normalizePlatformInput, platformIdSchema, publishVariantInputSchema, resolveResponseSchema, resolveSlug, resolvedRuleSchema, ruleBundleSchema, ruleConfigSchema, rulePublishInputSchema, ruleTypeSchema, ruleVariantSchema, ruleVersionSchema, supportsInstallPath, tagSchema, tagsSchema, titleSchema, toPosixPath, toUint8Array, toUtf8String, validateConfig, validateRule, verifyBundledFileChecksum };
+export { API_ENDPOINTS, COMMON_LICENSES, LATEST_VERSION, PLATFORMS, PLATFORM_IDS, PLATFORM_ID_TUPLE, PLATFORM_RULE_TYPES, RULE_CONFIG_FILENAME, RULE_SCHEMA_URL, RULE_TYPE_TUPLE, STATIC_BUNDLE_DIR, buildPublishInput, buildRegistry, bundledFileSchema, cleanInstallMessage, createDiffPreview, decodeBundledFile, decodeUtf8, descriptionSchema, encodeUtf8, fetchBundle, getInstallDir, getInstallPath, getLatestVersion, getPlatformConfig, getPlatformFromDir, getPlatforms, getRelativeInstallPath, getTypeConfig, getValidTypes, getVariant, getVersion, hasBundle, hasInlineContent, hasPlatform, inferInstructionPlatformsFromFileName, inferPlatformFromPath, inferTypeFromPath, isLikelyText, isPlatformDir, isSupportedPlatform, isValidType, licenseSchema, nameSchema, normalizeBundlePath, normalizePlatformEntry, normalizePlatformInput, normalizeSkillFiles, platformIdSchema, publishVariantInputSchema, resolveResponseSchema, resolveSlug, resolvedRuleSchema, ruleBundleSchema, ruleConfigSchema, rulePublishInputSchema, ruleTypeSchema, ruleVariantSchema, ruleVersionSchema, supportsInstallPath, tagSchema, tagsSchema, titleSchema, toPosixPath, toUint8Array, toUtf8String, validateConfig, validateRule, verifyBundledFileChecksum };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agentrules/core",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "author": "Brian Cheung <bcheung.dev@gmail.com> (https://github.com/bcheung)",
   "license": "MIT",
   "homepage": "https://agentrules.directory",