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.

AI index

notifications.markRead

Mark a notification as read.

  • Type: operation (command)
  • Version: 1.0.0
  • Stability: stable
  • Owners: platform.notifications
  • Tags: notifications, read
  • File: packages/modules/notifications/src/contracts/index.ts
    • field.key.label
    notifications.markRead
    field.version.label
    1.0.0
    field.type.label
    operation (command)
    field.title.label
    notifications.markRead
    field.description.label

    Mark a notification as read.

  • Type: operation (command)
  • Version: 1.0.0
  • Stability: stable
  • Owners: platform.notifications
  • Tags: notifications, read
  • File: packages/modules/notifications/src/contracts/index.ts
    • field.tags.label
    notifications,read
    field.owners.label
    platform.notifications
    field.stability.label
    stable

    Mark a notification as read.

    Goal

    Track which notifications user has seen.

    Context

    User clicks on a notification.

    Source Definition

    import { defineCommand, defineQuery } from '@lssm-tech/lib.contracts-spec';
import {
	defineEnum,
	defineSchemaModel,
	ScalarTypeEnum,
} from '@lssm-tech/lib.schema';

export const MarkNotificationReadContract = defineCommand({
	meta: {
		key: 'notifications.markRead',
		version: '1.0.0',
		stability: 'stable',
		owners: ['platform.notifications'],
		tags: ['notifications', 'read'],
		description: 'Mark a notification as read.',
		goal: 'Track which notifications user has seen.',
		context: 'User clicks on a notification.',
	},
	io: {
		input: defineSchemaModel({
			name: 'MarkNotificationReadInput',
			fields: {
				notificationId: {
					type: ScalarTypeEnum.String_unsecure(),
					isOptional: false,
				},
			},
		}),
		output: NotificationModel,
	},
	policy: {
		auth: 'user',
	},
});