Release to npm

[lkostrowski]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

@saleor/app-sdk@1.0.0

Major Changes

• 8dc8d4a: Changed publically exported paths. New exports will be documented in docs and migration guide

• 3dfb91c: requiredEnvVars param was removed trom SaleorApp. Field was not used internally. Apps should validate it's envs.

• 51caa77: Removed /middlewares, you should use /handlers instead.

• 51caa77: Removed deprecated fields fields and methods in /handlers:

  • SaleorAsyncWebhook and SaleorSyncWebhook - removed deprecated asyncEvent and subscriptionQueryAst
  • Removed processSaleorWebhook and processProtectedHandler methods in favor of SaleorSyncWebhook, SaleorAsyncWebhook classes and createProtectedHandler handler
  • Some types were moved from /next to /shared

• a915771: ### APL

  • isReady and isConfigured methods are now optional in the APL interface
  • All APL implementations are now exported from dedicated paths @saleor/app-sdk/APL/* where * is one of the implementations. Now tree shaking is available

• 126493d: Generating AppBridge action now uses native web API Crypto.

  • Some older browser may not be working
  • Only localhost and https is supported now

• 5b0f7a8: Removed ctx.buildResponse parameter from SyncWebhookHandler ctx and replace with standalone buildSyncWebhookResponsePayload function

  Before

  new SaleorSyncWebhook(...).createHandler(
    req, res, ctx
  ) {
  
    const typeSafePayload = ctx.buildResponse({
      // this must be valid response
    })
  }

  After

  import { buildSyncWebhookResponsePayload } from "@saleor/app-sdk/handlers/shared";
  
  new SaleorSyncWebhook(...).createHandler(
    req, res, ctx
  )
  {
  
    const typeSafePayload = buildSyncWebhookResponsePayload<"ORDER_CALCULATE_TAXES">({
      // this must be valid shape
    })
  }

  This change reduces complexity of TypeScript generics and make it easier to build abstractions on top of built-in handlers

• 3dfb91c: Saleor version that was previously represented as a floating number (eg Saleor 3.20 was represented as 3.2) is now a SaleorSchemaVersion which is a tuple major: number, minor: number. This format is now passed to Manifest handler and webhooks handler

• 8dc8d4a: Added new root exports: auth/browser and auth/node for token-related utilities

• 6875d17: MetadataManager now requires deleteMetadata to be defined

• c956220: Breaking change: SDK will no longer check saleor-domain header when validating Saleor requests, instead it will check saleor-api-url header.

Minor Changes

• 4fa8271: Added handlers for Web API: Request and Response

  Example

  This example uses Next.js app router

  /* /app/api/manifest/route.ts */
  import { createManifestHandler } from "@saleor/app-sdk/handlers/fetch-api";
  // or
  import { createManifestHandler } from "@saleor/app-sdk/handlers/next-app-router";
  
  export const GET = createManifestHandler({
    manifestFactory({ appBaseUrl, request }) {
      return {
        name: "Saleor App Template",
        tokenTargetUrl: `${appBaseUrl}/api/register`,
        appUrl: appBaseUrl,
        permissions: ["MANAGE_ORDERS"],
        id: "saleor.app",
        version: "0.0.1",
        webhooks: [orderCreatedWebhook.getWebhookManifest(apiBaseURL)],
        author: "Saleor Commerce",
      };
    },
  });

  /* /app/api/register/route.ts */
  import { createAppRegisterHandler } from "@saleor/app-sdk/handlers/fetch-api";
  
  export const POST = createAppRegisterHandler({
    apl: saleorApp.apl,
  });

  To see more details check these examples:

  • Hono on Deno Deploy
  • Hono on Cloudflare Pages
  • Hono on AWS Lambda
  • Next.js Edge Runtime

• 51caa77: Added abstract PlatformAdapterInterface and ActionHandlerInterface to enable cross-framework handler implementations.

  Next.js handlers were rewritten to use the new interface.

• 5e4eb20: Add new exported path "util" with helper methods like parseSchemaVersion

Patch Changes

• 003b1ca: Added author and license fields to pacakge.json

• 003b1ca: Updated project license: it previously used BSD 3-Clause for code and Creative Commons Attribution 4.0 International License for artwork.
  Since this project doesn't include any artwork, Creative Commons license was removed.

  Updated license field in package.json: It incorrectly stated ISC license instead of BSD-3-Clause.

• 8f6b437: Updated Typescript

• 0a917ac: Updated packages: vite, vitest, raw-body, prettier, tsup, jose

• 5fb68e6: Schema version passed to manifest handler will be string, not float

• 853abaa: Added AWS Lambda platform handlers

  Check this example on how to use it.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.81%. Comparing base (12b2fd1) to head (edde57b).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #394   +/-   ##
=======================================
  Coverage   83.81%   83.81%           
=======================================
  Files         107      107           
  Lines        3497     3497           
  Branches      588      588           
=======================================
  Hits         2931     2931           
  Misses        555      555           
  Partials       11       11           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.