shopify-nuxt 0.0.1

package/dist/runtime/server/utils/unauthenticated-storefront.d.ts

@@ -0,0 +1,24 @@
+import type { Session } from '@shopify/shopify-api';
+export interface StorefrontApiContext {
+    graphql: (query: string, options?: {
+        variables?: Record<string, any>;
+    }) => Promise<any>;
+}
+/**
+ * Get an unauthenticated Storefront API context for a given shop.
+ *
+ * Uses the stored offline session to access the Storefront API without an incoming request.
+ *
+ * ```ts
+ * // server/api/public/products.ts
+ * export default defineEventHandler(async (event) => {
+ *   const { storefront } = await useShopifyUnauthenticatedStorefront('my-shop.myshopify.com')
+ *   const products = await storefront.graphql(`{ products(first: 10) { edges { node { id title } } } }`)
+ *   return products
+ * })
+ * ```
+ */
+export declare function useShopifyUnauthenticatedStorefront(shop: string): Promise<{
+    storefront: StorefrontApiContext;
+    session: Session;
+}>;

package/dist/runtime/server/utils/unauthenticated-storefront.js

@@ -0,0 +1,21 @@
+import { getShopifyApi, getSessionStorage } from "../services/shopify.js";
+export async function useShopifyUnauthenticatedStorefront(shop) {
+  const api = getShopifyApi();
+  const sessionStorage = getSessionStorage();
+  const offlineId = api.session.getOfflineId(shop);
+  const session = await sessionStorage.loadSession(offlineId);
+  if (!session) {
+    throw new Error(
+      `No offline session found for shop "${shop}". The shop must install the app first.`
+    );
+  }
+  const storefront = {
+    graphql: async (query, options) => {
+      const client = new api.clients.Storefront({ session });
+      return client.request(query, {
+        variables: options?.variables
+      });
+    }
+  };
+  return { storefront, session };
+}

package/dist/runtime/types.d.ts

@@ -0,0 +1,141 @@
+import type { ApiVersion, Session, JwtPayload, WebhookHandler } from '@shopify/shopify-api';
+import type { SessionStorage } from '@shopify/shopify-app-session-storage';
+import type { AdminApiContext } from './server/utils/clients.js';
+export declare enum AppDistribution {
+    AppStore = "app_store",
+    SingleMerchant = "single_merchant",
+    ShopifyAdmin = "shopify_admin"
+}
+export interface ModuleOptions {
+    /**
+     * The Shopify API key for your app.
+     * Can also be set via `NUXT_SHOPIFY_API_KEY` env var.
+     */
+    apiKey: string;
+    /**
+     * The Shopify API secret key for your app.
+     * Can also be set via `NUXT_SHOPIFY_API_SECRET_KEY` env var.
+     */
+    apiSecretKey: string;
+    /**
+     * The scopes your app needs from the Shopify API.
+     */
+    scopes: string[];
+    /**
+     * The URL your app is running on. In development, this is typically a tunnel URL.
+     * Can also be set via `NUXT_SHOPIFY_APP_URL` env var.
+     */
+    appUrl: string;
+    /**
+     * The Shopify API version to use. Defaults to the latest stable version.
+     */
+    apiVersion?: ApiVersion;
+    /**
+     * A path prefix for Shopify auth endpoints.
+     * @default '/_shopify/auth'
+     */
+    authPathPrefix?: string;
+    /**
+     * How your app is distributed.
+     * @default 'app_store'
+     */
+    distribution?: AppDistribution;
+    /**
+     * Whether to use online tokens (user-specific) instead of offline tokens (shop-specific).
+     * If true, both online and offline tokens will be stored.
+     * @default false
+     */
+    useOnlineTokens?: boolean;
+}
+export type WebhookConfig = Record<string, WebhookHandler | WebhookHandler[]>;
+export interface AfterAuthOptions {
+    session: Session;
+    admin: AdminApiContext;
+}
+export interface HooksConfig {
+    afterAuth?: (options: AfterAuthOptions) => void | Promise<void>;
+}
+export interface ShopifyRuntimeConfig {
+    /** Session storage adapter */
+    sessionStorage?: SessionStorage;
+    /** Webhook handler configuration */
+    webhooks?: WebhookConfig;
+    /** Lifecycle hooks */
+    hooks?: HooksConfig;
+    /** Billing configuration */
+    billing?: Record<string, any>;
+}
+export interface AdminContext {
+    /** The authenticated session */
+    session: Session;
+    /** Admin API client (graphql + rest) */
+    admin: AdminApiContext;
+    /** The decoded session token (embedded apps only) */
+    sessionToken?: JwtPayload;
+    /** Billing helpers */
+    billing: BillingContext;
+    /** CORS header helper */
+    cors: (response: Response) => Response;
+    /** Redirect helper for embedded apps */
+    redirect: (url: string, init?: {
+        target?: '_self' | '_parent' | '_top' | '_blank';
+    }) => Response;
+}
+export interface BillingContext {
+    require: (options: {
+        plans: string | string[];
+    }) => Promise<void>;
+    check: (options?: {
+        plans?: string | string[];
+    }) => Promise<any>;
+    request: (options: {
+        plan: string;
+        isTest?: boolean;
+        returnUrl?: string;
+    }) => Promise<Response>;
+}
+export interface WebhookContext {
+    topic: string;
+    shop: string;
+    session?: Session;
+    payload: Record<string, any>;
+    apiVersion: string;
+}
+export interface FlowContext {
+    session: Session;
+    admin: AdminApiContext;
+    payload: Record<string, any>;
+}
+export interface PublicContext {
+    sessionToken: JwtPayload;
+    cors: (response: Response) => Response;
+}
+export interface LoginError {
+    shop?: LoginErrorType;
+}
+export declare enum LoginErrorType {
+    MissingShop = "MISSING_SHOP",
+    InvalidShop = "INVALID_SHOP"
+}
+export interface AuthConfig {
+    path: string;
+    callbackPath: string;
+    exitIframePath: string;
+    patchSessionTokenPath: string;
+    loginPath: string;
+}
+export interface ResolvedConfig {
+    apiKey: string;
+    apiSecretKey: string;
+    scopes: string[];
+    appUrl: string;
+    apiVersion: string;
+    authPathPrefix: string;
+    distribution: AppDistribution;
+    useOnlineTokens: boolean;
+    auth: AuthConfig;
+    sessionStorage?: SessionStorage;
+    webhooks?: WebhookConfig;
+    hooks: HooksConfig;
+    billing?: Record<string, any>;
+}

package/dist/runtime/types.js

@@ -0,0 +1,11 @@
+export var AppDistribution = /* @__PURE__ */ ((AppDistribution2) => {
+  AppDistribution2["AppStore"] = "app_store";
+  AppDistribution2["SingleMerchant"] = "single_merchant";
+  AppDistribution2["ShopifyAdmin"] = "shopify_admin";
+  return AppDistribution2;
+})(AppDistribution || {});
+export var LoginErrorType = /* @__PURE__ */ ((LoginErrorType2) => {
+  LoginErrorType2["MissingShop"] = "MISSING_SHOP";
+  LoginErrorType2["InvalidShop"] = "INVALID_SHOP";
+  return LoginErrorType2;
+})(LoginErrorType || {});

package/dist/types.d.mts

@@ -0,0 +1,3 @@
+export { type ModuleOptions } from '../dist/runtime/types.js'
+
+export { default } from './module.mjs'

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "shopify-nuxt",
+  "version": "0.0.1",
+  "description": "Shopify app integration for Nuxt - authentication, webhooks, billing, and App Bridge",
+  "repository": "yanuaraditia/shopify-nuxt",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    },
+    "./test-helpers": {
+      "types": "./dist/runtime/server/test-helpers/index.d.ts",
+      "import": "./dist/runtime/server/test-helpers/index.js"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "workspaces": [
+    "playground"
+  ],
+  "scripts": {
+    "prepack": "nuxt-module-build build",
+    "dev": "bun run dev:prepare && nuxt dev playground",
+    "dev:build": "nuxt build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt prepare playground",
+    "release": "bun run lint && bun run test && bun run prepack && changelogen --release && npm publish && git push --follow-tags",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^4.4.2",
+    "@shopify/app-bridge-types": "^0.7.0",
+    "@shopify/cli": "^3.92.1",
+    "@shopify/polaris-types": "^1.0.1",
+    "@shopify/shopify-api": "^13.0.0",
+    "@shopify/shopify-app-session-storage": "^5.0.0",
+    "isbot": "^5.1.36"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "^3.2.4",
+    "@nuxt/eslint-config": "^1.15.2",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.4.2",
+    "@nuxt/test-utils": "^4.0.0",
+    "@types/node": "^25.5.0",
+    "changelogen": "^0.6.2",
+    "eslint": "^10.1.0",
+    "nuxt": "^4.4.2",
+    "typescript": "6.0.2",
+    "vitest": "^4.1.2",
+    "vue-tsc": "^3.2.6"
+  }
+}