OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

pfo.openbanking.generate-overview

Aggregates balances and transactions into a derived financial overview stored in the knowledge layer.

  • Type: operation (command)
  • Version: 1.0.0
  • Tags: open-banking, summary
  • File: packages/examples/pocket-family-office/src/operations/index.ts
  • field.key.label
    pfo.openbanking.generate-overview
    field.version.label
    1.0.0
    field.type.label
    operation (command)
    field.title.label
    pfo.openbanking.generate-overview
    field.description.label

    Aggregates balances and transactions into a derived financial overview stored in the knowledge layer.

  • Type: operation (command)
  • Version: 1.0.0
  • Tags: open-banking, summary
  • File: packages/examples/pocket-family-office/src/operations/index.ts
  • field.tags.label
    open-banking,summary
    field.owners.label
    field.stability.label

    Aggregates balances and transactions into a derived financial overview stored in the knowledge layer.

    Goal

    Create a periodic financial snapshot.

    Context

    Aggregates data from open banking integration into a document.

    Source Definition

    import { OPENBANKING_TELEMETRY_EVENTS } from '@lssm-tech/lib.contracts-integrations';
    import {
    	defineCommand,
    	defineQuery,
    	type OperationSpec,
    } from '@lssm-tech/lib.contracts-spec';
    import {
    	OwnersEnum,
    	StabilityEnum,
    	TagsEnum,
    } from '@lssm-tech/lib.contracts-spec/ownership';
    import {
    	defineEnum,
    	defineSchemaModel,
    	ScalarTypeEnum,
    	type ZodSchemaModel,
    } from '@lssm-tech/lib.schema';
    
    export const generateOpenBankingOverviewContract = defineCommand({
    	meta: {
    		key: 'pfo.openbanking.generate-overview',
    		version: '1.0.0',
    		description:
    			'Aggregates balances and transactions into a derived financial overview stored in the knowledge layer.',
    		goal: 'Create a periodic financial snapshot.',
    		context: 'Aggregates data from open banking integration into a document.',
    		owners: [OwnersEnum.PlatformFinance],
    		tags: ['open-banking', 'summary', TagsEnum.Automation],
    		stability: StabilityEnum.Experimental,
    	},
    	io: {
    		input: OpenBankingOverviewInputModel,
    		output: OpenBankingOverviewOutputModel,
    	},
    	policy: {
    		auth: 'user',
    	},
    	telemetry: {
    		success: {
    			event: {
    				key: OPENBANKING_TELEMETRY_EVENTS.overviewGenerated,
    				version: '1.0.0',
    			},
    		},
    	},
    });