feat: unflag cache

Author: twlite

apps/test-bot/src/commands/misc/invalidate-random.ts

@@ -1,8 +1,4 @@
-import {
-  SlashCommandProps,
-  CommandData,
-  unstable_invalidate as invalidate,
-} from 'commandkit';
+import { SlashCommandProps, CommandData, invalidate } from 'commandkit';
 
 export const data: CommandData = {
   name: 'invalidate-random',

apps/test-bot/src/commands/misc/random.ts

@@ -1,8 +1,4 @@
-import {
-  SlashCommandProps,
-  CommandData,
-  unstable_cache as cache,
-} from 'commandkit';
+import { SlashCommandProps, CommandData, cache } from 'commandkit';
 
 export const data: CommandData = {
   name: 'random',

apps/test-bot/src/commands/misc/revalidate-random.ts

@@ -1,8 +1,4 @@
-import {
-  SlashCommandProps,
-  CommandData,
-  unstable_revalidate as revalidate,
-} from 'commandkit';
+import { SlashCommandProps, CommandData, revalidate } from 'commandkit';
 
 export const data: CommandData = {
   name: 'revalidate-random',

apps/test-bot/src/commands/misc/xp.ts

@@ -1,8 +1,4 @@
-import {
-  SlashCommandProps,
-  CommandData,
-  unstable_cacheTag as cacheTag,
-} from 'commandkit';
+import { SlashCommandProps, CommandData, cacheTag } from 'commandkit';
 import { database } from '../../database/store';
 
 export const data: CommandData = {

apps/test-bot/src/events/messageCreate/give-xp.ts

@@ -1,5 +1,5 @@
 import type { Message } from 'discord.js';
-import { unstable_invalidate as invalidate } from 'commandkit';
+import { invalidate } from 'commandkit';
 import { database } from '../../database/store';
 
 export default async function (message: Message) {

apps/website/docs/guide/11-caching.mdx

@@ -5,11 +5,6 @@ description: A guide on how to implement caching in your bot using CommandKit.
 
 # Caching
 
-:::warning
-This feature is currently available in development version of CommandKit only. Since it is an unstable feature, it may change in the future.
-You need to prefix the function with `unstable_` to use this feature until it is stable.
-:::
-
 Caching is a technique used to store data in a temporary storage to reduce the time it takes to fetch the data from the original source. This can be useful in Discord bots to reduce the number of database queries or external API calls.
 
 CommandKit provides an easy way to implement caching in your bot without having to worry about the underlying implementation. This guide will show you how to use the caching feature in CommandKit.
@@ -58,11 +53,7 @@ Let's build a simple XP system using CommandKit's caching feature. We'll create:
 ### XP Command
 
 ```js
-import {
-  SlashCommandProps,
-  CommandData,
-  unstable_cacheTag as cacheTag,
-} from 'commandkit';
+import { SlashCommandProps, CommandData, cacheTag } from 'commandkit';
 import { database } from '../database';
 
 export const data = {
@@ -93,7 +84,7 @@ export async function run({ interaction }) {
 ### XP Event Handler
 
 ```js
-import { unstable_invalidate as invalidate } from 'commandkit';
+import { invalidate } from 'commandkit';
 import { database } from '../database';
 
 // Give XP when user sends a message
@@ -120,7 +111,7 @@ In this example:
 ### Pattern 1: Cache with Auto-Expiry
 
 ```js
-import { unstable_cache as cache } from 'commandkit';
+import { cache } from 'commandkit';
 
 // Cache API results for 5 minutes
 const fetchPokemon = cache(
@@ -160,7 +151,7 @@ async function updateUserProfile(userId, data) {
 ### Pattern 3: Forced Refresh with Revalidation
 
 ```js
-import { unstable_revalidate as revalidate } from 'commandkit';
+import { revalidate as revalidate } from 'commandkit';
 
 // Command to force refresh server stats
 export async function run({ interaction }) {
@@ -230,7 +221,7 @@ The `'use cache'` directive will only work if you are using the commandkit cli t
 ### Using the cache manually
 
 ```js
-import { unstable_cache as cache } from 'commandkit';
+import { cache } from 'commandkit';
 
 const fetchData = cache(
   async () => {
@@ -252,7 +243,7 @@ By default, the cached data will be stored for 15 minutes unless `revalidate()`
 When using the `"use cache"` directive, you can use `cacheTag()` to set cache parameters:
 
 ```js
-import { unstable_cacheTag as cacheTag } from 'commandkit';
+import { cacheTag } from 'commandkit';
 
 async function fetchData() {
   'use cache';
@@ -272,7 +263,7 @@ async function fetchData() {
 You can also set just the TTL using `cacheLife`:
 
 ```js
-import { unstable_cacheLife as cacheLife } from 'commandkit';
+import { cacheLife } from 'commandkit';
 
 async function fetchData() {
   'use cache';
@@ -298,7 +289,7 @@ async function fetchData() {
 To immediately remove cached data:
 
 ```js
-import { unstable_invalidate as invalidate } from 'commandkit';
+import { invalidate } from 'commandkit';
 
 // Remove the cache entry immediately
 await invalidate('user-data');
@@ -309,7 +300,7 @@ await invalidate('user-data');
 To force refresh the cached data:
 
 ```js
-import { unstable_revalidate as revalidate } from 'commandkit';
+import { revalidate } from 'commandkit';
 
 // Revalidate and get fresh data
 const freshData = await revalidate('user-data');

packages/commandkit/bin/esbuild-plugins/use-cache.mjs

@@ -9,7 +9,7 @@ const generate = _generate.default || _generate;
 const IMPORT_PATH = 'commandkit';
 const DIRECTIVE = 'use cache';
 const CACHE_IDENTIFIER =
-  'unstable_super_duper_secret_internal_for_use_cache_directive_of_commandkit_cli_do_not_use_it_directly_or_you_will_be_fired_from_your_job_kthxbai';
+  'super_duper_secret_internal_for_use_cache_directive_of_commandkit_cli_do_not_use_it_directly_or_you_will_be_fired_from_your_job_kthxbai';
 
 const generateRandomString = (length = 6) => {
   const chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';

packages/commandkit/src/cache/cache.ts

@@ -1,7 +1,6 @@
 import { AsyncLocalStorage } from 'node:async_hooks';
 import ms from 'ms';
 import { GenericFunction, getCommandKit } from '../context/async-context';
-import { warnUnstable } from '../utils/warn-unstable';
 import { randomUUID } from 'node:crypto';
 
 export type AsyncFunction<R extends any[] = any[], T = any> = (
@@ -49,7 +48,6 @@ function cache<R extends any[], F extends AsyncFunction<R>>(
   fn: F,
   params?: Partial<CacheTag>,
 ): F {
-  warnUnstable('cache');
   params = Object.assign({}, getDefaultCacheTag(), params);
 
   return useCache(fn, __identificationKey, params as CacheTag);
@@ -71,10 +69,6 @@ function useCache<R extends any[], F extends AsyncFunction<R>>(
 
   const isLocal = id === __identificationKey;
 
-  if (!isLocal) {
-    warnUnstable('"use cache"');
-  }
-
   const memoized = (async (...args) => {
     const commandkit = getCommandKit(true);
     const cache = commandkit.getCacheProvider();
@@ -173,8 +167,6 @@ function cacheTag(tag: CacheTag | string): void {
     throw new TypeError('cacheTag must be called with a tag.');
   }
 
-  warnUnstable('cacheTag');
-
   const context = cacheContext.getStore();
 
   if (context === undefined) {
@@ -208,8 +200,6 @@ function cacheLife(life: string | number) {
     throw new TypeError('cacheLife must be called with a time-to-live value.');
   }
 
-  warnUnstable('cacheLife');
-
   const context = cacheContext.getStore();
 
   if (context === undefined) {
@@ -231,7 +221,6 @@ function cacheLife(life: string | number) {
  * @param tag The cache tag to invalidate.
  */
 async function invalidate(tag: string) {
-  warnUnstable('invalidate');
   const commandkit = getCommandKit(true);
   const cache = commandkit.getCacheProvider();
 
@@ -255,7 +244,6 @@ async function revalidate<R = any>(
   tag: string,
   ...args: any[]
 ): Promise<R | undefined> {
-  warnUnstable('revalidate');
   const commandkit = getCommandKit(true);
   const cache = commandkit.getCacheProvider();
 
@@ -277,10 +265,10 @@ async function revalidate<R = any>(
 }
 
 export {
-  cache as unstable_cache,
-  useCache as unstable_super_duper_secret_internal_for_use_cache_directive_of_commandkit_cli_do_not_use_it_directly_or_you_will_be_fired_from_your_job_kthxbai,
-  cacheTag as unstable_cacheTag,
-  cacheLife as unstable_cacheLife,
-  invalidate as unstable_invalidate,
-  revalidate as unstable_revalidate,
+  cache,
+  useCache as super_duper_secret_internal_for_use_cache_directive_of_commandkit_cli_do_not_use_it_directly_or_you_will_be_fired_from_your_job_kthxbai,
+  cacheTag,
+  cacheLife,
+  invalidate,
+  revalidate,
 };

packages/redis/package.json

@@ -33,4 +33,4 @@
     "tsconfig": "workspace:*",
     "typescript": "^5.7.3"
   }
-}
+}

packages/tsconfig/base.json

@@ -9,6 +9,6 @@
     "moduleResolution": "Node",
     "module": "CommonJS",
     "declaration": true,
-    "isolatedModules": true,
+    "isolatedModules": true
   }
-}
+}