@agentrules/core 0.2.0 → 0.2.1

package/dist/index.d.ts

@@ -316,6 +316,19 @@ 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.
@@ -453,11 +466,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";
+  rule: "rule";
+  skill: "skill";
 }>;
 /**
  * Rule config schema.
@@ -472,11 +485,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";
+    rule: "rule";
+    skill: "skill";
   }>>;
   title: z.ZodString;
   version: z.ZodOptional<z.ZodNumber>;
@@ -539,11 +552,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";
+    rule: "rule";
+    skill: "skill";
   }>>;
   title: z.ZodString;
   description: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -577,11 +590,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";
+    rule: "rule";
+    skill: "skill";
   }>>;
   platform: z.ZodEnum<{
     opencode: "opencode";
@@ -947,4 +960,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, 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, getRelativeInstallPath, 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 };

package/dist/index.js

@@ -156,6 +156,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.
 */
@@ -674,7 +689,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 +907,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, 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, 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.2.1",
   "author": "Brian Cheung <bcheung.dev@gmail.com> (https://github.com/bcheung)",
   "license": "MIT",
   "homepage": "https://agentrules.directory",