Package

Package Identity Protocol

A package (also called a Solution in Power Platform, an Unlocked Package in Salesforce, or an Application in ServiceNow) is the first-class unit of distribution in ObjectStack. It groups related metadata — objects, views, flows, translations, agents — into a named, versioned artifact.

Architecture:

sys_package — identity (one row per logical package)
sys_package_version — immutable release snapshots (see package-version.zod.ts)
sys_package_installation — env ↔ version pairing (see environment-package.zod.ts)

See docs/adr/0003-package-as-first-class-citizen.md for the full rationale.

Source: packages/spec/src/cloud/package.zod.ts

TypeScript Usage

import { CreatePackageRequestSchema, PackageSchema, PackageCategorySchema, PackageLocaleSchema, PackagePublisherSchema, PackageTranslationSchema, PackageTranslationsSchema, PackageVisibilitySchema, UpdatePackageRequestSchema } from '@objectstack/spec/cloud';
import type { CreatePackageRequest, Package, PackageCategory, PackageLocale, PackagePublisher, PackageTranslation, PackageTranslations, PackageVisibility, UpdatePackageRequest } from '@objectstack/spec/cloud';

// Validate data
const result = CreatePackageRequestSchema.parse(data);

CreatePackageRequest

Properties

Property	Type	Required	Description
manifestId	`string`	✅	Globally unique reverse-domain package identifier (e.g. com.acme.crm)
namespace	`string`	optional	Metadata namespace claimed by the package (mirrors manifest.namespace; e.g. "crm" → object names "crm_account")
ownerOrgId	`string`	✅	Owner organization ID
displayName	`string`	✅	Display name shown in Studio and Marketplace
description	`string`	optional	Short package description
visibility	`Enum<'private' \| 'org' \| 'marketplace'>`	optional	Package visibility: private = owner org only; org = all envs in owner org; marketplace = public registry
category	`string`	optional	Package category for marketplace discovery (e.g. "crm", "hr", "finance", "devtools")
tags	`string[]`	optional
iconUrl	`string`	optional
homepageUrl	`string`	optional
license	`string`	optional
publisher	`Enum<'objectstack' \| 'partner' \| 'community' \| 'private'>`	optional	Package publisher provenance tier
isStarter	`boolean`	optional
translations	`Record<string, { displayName?: string; description?: string; readme?: string; tagline?: string; … }>`	optional	Locale-keyed overrides; missing keys fall back to base columns
createdBy	`string`	✅	User ID creating the package

Properties

Property	Type	Required	Description
id	`string`	✅	UUID of the package (stable, never reused)
manifestId	`string`	✅	Globally unique reverse-domain package identifier (e.g. com.acme.crm)
namespace	`string`	optional	Metadata namespace claimed by the package (mirrors manifest.namespace; e.g. "crm" → object names "crm_account")
ownerOrgId	`string`	✅	Organization ID of the package owner/publisher
displayName	`string`	✅	Display name shown in Studio and Marketplace
description	`string`	optional	Short package description
readme	`string`	optional	Long-form package documentation (markdown)
visibility	`Enum<'private' \| 'org' \| 'marketplace'>`	✅	Package visibility: private = owner org only; org = all envs in owner org; marketplace = public registry
category	`string`	optional	Package category for marketplace discovery (e.g. "crm", "hr", "finance", "devtools")
tags	`string[]`	optional	Search and filter tags
iconUrl	`string`	optional	Package icon URL
homepageUrl	`string`	optional	Package homepage URL
license	`string`	optional	SPDX license identifier (e.g. MIT, Apache-2.0)
publisher	`Enum<'objectstack' \| 'partner' \| 'community' \| 'private'>`	✅	Package publisher provenance tier
isStarter	`boolean`	✅	If true, surfaces in the Create Project blueprint picker as a starter template
translations	`Record<string, { displayName?: string; description?: string; readme?: string; tagline?: string; … }>`	optional	Locale-keyed overrides for display_name / description / readme
createdAt	`string`	✅	Creation timestamp (ISO-8601)
updatedAt	`string`	✅	Last update timestamp (ISO-8601)
createdBy	`string`	✅	User ID that created the package

PackageCategory

Package category for marketplace discovery (e.g. "crm", "hr", "finance", "devtools")

Type: string

PackageLocale

BCP-47 locale tag

Type: string

PackagePublisher

Package publisher provenance tier

Allowed Values

objectstack
partner
community
private

PackageTranslation

Per-locale overrides for a package listing

Properties

Property	Type	Required	Description
displayName	`string`	optional	Localized display name
description	`string`	optional	Localized short description
readme	`string`	optional	Localized long-form readme (markdown)
tagline	`string`	optional	Localized short tagline (marketplace listing only)
screenshotCaptions	`Record<string, string>`	optional	Per-index screenshot caption overrides

PackageTranslations

Locale-keyed overrides; missing keys fall back to base columns

Type: Record<string, { displayName?: string; description?: string; readme?: string; tagline?: string; … }>

PackageVisibility

Package visibility: private = owner org only; org = all envs in owner org; marketplace = public registry

Allowed Values

private
org
marketplace

UpdatePackageRequest

Update mutable package metadata

Properties

Property	Type	Required	Description
displayName	`string`	optional	Display name shown in Studio and Marketplace
description	`string`	optional	Short package description
readme	`string`	optional	Long-form package documentation (markdown)
visibility	`Enum<'private' \| 'org' \| 'marketplace'>`	optional	Package visibility: private = owner org only; org = all envs in owner org; marketplace = public registry
category	`string`	optional	Package category for marketplace discovery (e.g. "crm", "hr", "finance", "devtools")
tags	`string[]`	optional
iconUrl	`string`	optional
homepageUrl	`string`	optional
license	`string`	optional
publisher	`Enum<'objectstack' \| 'partner' \| 'community' \| 'private'>`	optional	Package publisher provenance tier
isStarter	`boolean`	optional
translations	`Record<string, { displayName?: string; description?: string; readme?: string; tagline?: string; … }>`	optional	Locale-keyed overrides; missing keys fall back to base columns

Package

On this page