@crombolo/api-management 0.9.1 → 0.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crombolo/api-management",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "description": "Umbraco-compatible Management API handlers for crombolo.",
   "license": "MIT",
   "author": "Crombolo",
@@ -28,7 +28,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@crombolo/core": "0.9.1",
-    "@crombolo/contracts": "0.9.1"
+    "@crombolo/core": "0.10.0",
+    "@crombolo/contracts": "0.10.0"
   }
 }

package/src/authorization.ts

@@ -4,7 +4,7 @@
  * every set), then, for documents and media, the caller's start nodes and the
  * permission verbs the operation needs on the nodes it names. Users and user
  * groups carry rules about the people involved, which their port enforces.
- * See docs/04-backoffice-hosting.md for the table's provenance.
+ * See docs/backoffice-hosting.md for the table's provenance.
  */
 import type { OperationInfo } from '@crombolo/contracts'
 import {

package/src/handlers/media.ts

@@ -440,7 +440,7 @@ export function registerMediaHandlers(router: ManagementApiRouter, port: MediaPo
     return done(ctx)
   })
 
-  // References arrive with relations (WP-6.9); nothing is known to refer yet.
+  // References arrive with relations (story 046); nothing is known to refer yet.
   for (const operation of [
     'GetMediaByIdReferencedBy',
     'GetMediaByIdReferencedDescendants',

package/src/handlers/package.ts

@@ -26,14 +26,18 @@ import { created } from './content-type.ts'
 
 const packageNotFound = () => problemResponse(notFound('The package could not be found'))
 
-/** A download filename from a package name: no separators, no surprises. */
-export function packageFileName(name: string): string {
+/**
+ * A download filename, as `npm pack` names one: the package name with its scope
+ * folded in, then the version. No separators, no surprises.
+ */
+export function packageFileName(name: string, version = '1.0.0'): string {
   const slug = name
     .trim()
     .toLowerCase()
-    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^@/, '')
+    .replace(/[^a-z0-9.]+/g, '-')
     .replace(/^-+|-+$/g, '')
-  return `${slug || 'package'}.zip`
+  return `${slug || 'package'}-${version}.tgz`
 }
 
 const toResponse = (definition: PackageDefinition) => ({
@@ -161,7 +165,7 @@ export function registerPackageHandlers(router: ManagementApiRouter, port: Packa
     if (!built) return packageNotFound()
     return new Response(built.bytes, {
       headers: {
-        'content-type': 'application/zip',
+        'content-type': built.contentType,
         'content-disposition': `attachment; filename="${built.fileName}"`,
       },
     })

package/src/handlers/settings-stubs.ts

@@ -3,7 +3,7 @@
  * Settings, Media and Library sections. Each answers an honest empty result in
  * the shape its operation declares, so every section loads, expands and
  * deep-links without an error toast; every one is replaced by a real handler
- * when its work package lands (docs/07-roadmap.md, Phase 6). Counted
+ * when its story in docs/stories/ lands. Counted
  * separately by `coverage:api`.
  */
 import { invalidSkipTake, notFound, problemResponse } from '@crombolo/core'
@@ -23,10 +23,10 @@ const PAGED = [
     `GetRecycleBin${b}Children`,
     `GetRecycleBin${b}ReferencedBy`,
   ]),
-  'GetRecycleBinDocumentReferencedBy', // needs relations, WP-6.9
+  'GetRecycleBinDocumentReferencedBy', // needs relations, story 046
   'GetRecycleBinMediaReferencedBy',
   'GetRecycleBinElementReferencedBy',
-  // The recycle bin and the trash and delete dialogs; needs relations, WP-6.9. Until
+  // The recycle bin and the trash and delete dialogs; needs relations, story 046. Until
   // then they cannot warn that other content links to what is being removed.
   'GetTreeStaticFileRoot',
   'GetTreeStaticFileChildren',

package/src/handlers/user.ts

@@ -476,7 +476,7 @@ function registerUsers(router: ManagementApiRouter, users: UserPort): void {
     return found.status === 'Success' ? Response.json([]) : status(found.status)
   })
   router.handle('DeleteUserById2faByProviderName', noProvider)
-  // External backoffice logins arrive with WP-6.8's providers.
+  // External backoffice logins arrive with story 031's providers.
   router.handle('GetUserCurrentLoginProviders', () => Response.json([]))
 
   router.handle('PostSecurityForgotPassword', async (ctx) => {

package/src/ports-packages.ts

@@ -1,6 +1,6 @@
 /**
  * Created packages: the definitions the Packages section builds, and the zip a
- * download turns one into. `docs/17-bundles.md`.
+ * download turns one into. `docs/bundles.md`.
  *
  * The port hands back built bytes rather than a path, because the artifact is
  * never stored — it is serialized when it is asked for, so it cannot be stale.
@@ -41,6 +41,7 @@ export type PackageWriteStatus = 'NotFound' | 'DuplicateName' | 'InvalidName'
 /** A built package, ready to send. */
 export interface BuiltPackage {
   fileName: string
+  contentType: string
   /** Owns its buffer, so it can be a response body without a copy. */
   bytes: Uint8Array<ArrayBuffer>
 }
@@ -53,6 +54,6 @@ export interface PackagePort {
   create(input: PackageDefinitionInput, id: string | undefined): Promise<PackageWriteResult>
   update(id: string, input: PackageDefinitionInput): Promise<PackageWriteResult>
   remove(id: string): Promise<'deleted' | 'notFound'>
-  /** Serializes and zips the definition now; undefined when it is gone. */
+  /** Serializes and packs the definition now; undefined when it is gone. */
   build(id: string): Promise<BuiltPackage | undefined>
 }